Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Algolia Provider
  3. API Docs
  4. ApiKey
algolia 0.6.0 published on Monday, Apr 14, 2025 by k-yomo
k-yomo/terraform-provider-algolia

algolia.ApiKey

Explore with Pulumi AI

algolia logo
algolia 0.6.0 published on Monday, Apr 14, 2025 by k-yomo
k-yomo/terraform-provider-algolia

    A configuration for an API key

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as algolia from "@pulumi/algolia";

const example = new algolia.ApiKey("example", {
    acls: [
        "search",
        "browse",
    ],
    description: "This is a example api key",
    expiresAt: "2030-01-01T00:00:00Z",
    indexes: ["*"],
    maxHitsPerQuery: 100,
    maxQueriesPerIpPerHour: 10000,
    referers: ["https://algolia.com/\\*"],
});

    import pulumi
import pulumi_algolia as algolia

example = algolia.ApiKey("example",
    acls=[
        "search",
        "browse",
    ],
    description="This is a example api key",
    expires_at="2030-01-01T00:00:00Z",
    indexes=["*"],
    max_hits_per_query=100,
    max_queries_per_ip_per_hour=10000,
    referers=["https://algolia.com/\\*"])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/algolia/algolia"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := algolia.NewApiKey(ctx, "example", &algolia.ApiKeyArgs{
			Acls: pulumi.StringArray{
				pulumi.String("search"),
				pulumi.String("browse"),
			},
			Description: pulumi.String("This is a example api key"),
			ExpiresAt:   pulumi.String("2030-01-01T00:00:00Z"),
			Indexes: pulumi.StringArray{
				pulumi.String("*"),
			},
			MaxHitsPerQuery:        pulumi.Float64(100),
			MaxQueriesPerIpPerHour: pulumi.Float64(10000),
			Referers: pulumi.StringArray{
				pulumi.String("https://algolia.com/\\*"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Algolia = Pulumi.Algolia;

return await Deployment.RunAsync(() => 
{
    var example = new Algolia.ApiKey("example", new()
    {
        Acls = new[]
        {
            "search",
            "browse",
        },
        Description = "This is a example api key",
        ExpiresAt = "2030-01-01T00:00:00Z",
        Indexes = new[]
        {
            "*",
        },
        MaxHitsPerQuery = 100,
        MaxQueriesPerIpPerHour = 10000,
        Referers = new[]
        {
            "https://algolia.com/\\*",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.algolia.ApiKey;
import com.pulumi.algolia.ApiKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ApiKey("example", ApiKeyArgs.builder()
            .acls(            
                "search",
                "browse")
            .description("This is a example api key")
            .expiresAt("2030-01-01T00:00:00Z")
            .indexes("*")
            .maxHitsPerQuery(100)
            .maxQueriesPerIpPerHour(10000)
            .referers("https://algolia.com/\\*")
            .build());

    }
}

    resources:
  example:
    type: algolia:ApiKey
    properties:
      acls:
        - search
        - browse
      description: This is a example api key
      expiresAt: 2030-01-01T00:00:00Z
      indexes:
        - '*'
      maxHitsPerQuery: 100
      maxQueriesPerIpPerHour: 10000
      referers:
        - https://algolia.com/\*

    Create ApiKey Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApiKey(name: string, args: ApiKeyArgs, opts?: CustomResourceOptions);
    @overload
def ApiKey(resource_name: str,
           args: ApiKeyArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def ApiKey(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           acls: Optional[Sequence[str]] = None,
           api_key_id: Optional[str] = None,
           description: Optional[str] = None,
           expires_at: Optional[str] = None,
           indexes: Optional[Sequence[str]] = None,
           max_hits_per_query: Optional[float] = None,
           max_queries_per_ip_per_hour: Optional[float] = None,
           referers: Optional[Sequence[str]] = None)
    func NewApiKey(ctx *Context, name string, args ApiKeyArgs, opts ...ResourceOption) (*ApiKey, error)
    public ApiKey(string name, ApiKeyArgs args, CustomResourceOptions? opts = null)
    public ApiKey(String name, ApiKeyArgs args)
public ApiKey(String name, ApiKeyArgs args, CustomResourceOptions options)

    type: algolia:ApiKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var apiKeyResource = new Algolia.ApiKey("apiKeyResource", new()
{
    Acls = new[]
    {
        "string",
    },
    ApiKeyId = "string",
    Description = "string",
    ExpiresAt = "string",
    Indexes = new[]
    {
        "string",
    },
    MaxHitsPerQuery = 0,
    MaxQueriesPerIpPerHour = 0,
    Referers = new[]
    {
        "string",
    },
});

    example, err := algolia.NewApiKey(ctx, "apiKeyResource", &algolia.ApiKeyArgs{
	Acls: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiKeyId:    pulumi.String("string"),
	Description: pulumi.String("string"),
	ExpiresAt:   pulumi.String("string"),
	Indexes: pulumi.StringArray{
		pulumi.String("string"),
	},
	MaxHitsPerQuery:        pulumi.Float64(0),
	MaxQueriesPerIpPerHour: pulumi.Float64(0),
	Referers: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var apiKeyResource = new ApiKey("apiKeyResource", ApiKeyArgs.builder()
    .acls("string")
    .apiKeyId("string")
    .description("string")
    .expiresAt("string")
    .indexes("string")
    .maxHitsPerQuery(0)
    .maxQueriesPerIpPerHour(0)
    .referers("string")
    .build());

    api_key_resource = algolia.ApiKey("apiKeyResource",
    acls=["string"],
    api_key_id="string",
    description="string",
    expires_at="string",
    indexes=["string"],
    max_hits_per_query=0,
    max_queries_per_ip_per_hour=0,
    referers=["string"])

    const apiKeyResource = new algolia.ApiKey("apiKeyResource", {
    acls: ["string"],
    apiKeyId: "string",
    description: "string",
    expiresAt: "string",
    indexes: ["string"],
    maxHitsPerQuery: 0,
    maxQueriesPerIpPerHour: 0,
    referers: ["string"],
});

    type: algolia:ApiKey
properties:
    acls:
        - string
    apiKeyId: string
    description: string
    expiresAt: string
    indexes:
        - string
    maxHitsPerQuery: 0
    maxQueriesPerIpPerHour: 0
    referers:
        - string

    ApiKey Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ApiKey resource accepts the following input properties:

    Acls List<string>
    Set of permissions associated with the key. The possible ACLs are: - search: allowed to perform search operations. - browse: allowed to retrieve all index data with the browse endpoint. - addObject: allowed to add or update a records in the index. - deleteObject: allowed to delete an existing record. - listIndexes: allowed to get a list of all existing indices. - deleteIndex: allowed to delete an index. - settings: allowed to read all index settings. - editSettings: allowed to update all index settings. - analytics: allowed to retrieve data with the Analytics API. - recommendation: allowed to interact with the Recommendation API. - usage allowed to retrieve data with the Usage API. - nluReadAnswers: allowed to perform semantic search with the Answers API. - logs: allowed to query the logs. - seeUnretrievableAttributes: allowed to retrieve unretrievableAttributes for all operations that return records.
    ApiKeyId string
    Description string
    Description of the API key.
    ExpiresAt string
    Unix timestamp of the date at which the key expires. RFC3339 format. Will not expire per default.
    Indexes List<string>
    List of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the ‘*’ character. For example, “dev_*” matches all indices starting with “dev_” and “*_dev” matches all indices ending with “_dev”.
    MaxHitsPerQuery double
    Maximum number of hits this API key can retrieve in one call. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    MaxQueriesPerIpPerHour double
    Maximum number of API calls allowed from an IP address per hour.Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 429 code is returned. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    Referers List<string>
    List of referrers that can perform an operation. You can use the “*” (asterisk) character as a wildcard to match subdomains, or all pages of a website. For example, "https://algolia.com/\*" matches all referrers starting with "https://algolia.com/", and "\*.algolia.com" matches all referrers ending with ".algolia.com". If you want to allow all possible referrers from the algolia.com domain, you can use "\*algolia.com/\*".
    Acls []string
    Set of permissions associated with the key. The possible ACLs are: - search: allowed to perform search operations. - browse: allowed to retrieve all index data with the browse endpoint. - addObject: allowed to add or update a records in the index. - deleteObject: allowed to delete an existing record. - listIndexes: allowed to get a list of all existing indices. - deleteIndex: allowed to delete an index. - settings: allowed to read all index settings. - editSettings: allowed to update all index settings. - analytics: allowed to retrieve data with the Analytics API. - recommendation: allowed to interact with the Recommendation API. - usage allowed to retrieve data with the Usage API. - nluReadAnswers: allowed to perform semantic search with the Answers API. - logs: allowed to query the logs. - seeUnretrievableAttributes: allowed to retrieve unretrievableAttributes for all operations that return records.
    ApiKeyId string
    Description string
    Description of the API key.
    ExpiresAt string
    Unix timestamp of the date at which the key expires. RFC3339 format. Will not expire per default.
    Indexes []string
    List of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the ‘*’ character. For example, “dev_*” matches all indices starting with “dev_” and “*_dev” matches all indices ending with “_dev”.
    MaxHitsPerQuery float64
    Maximum number of hits this API key can retrieve in one call. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    MaxQueriesPerIpPerHour float64
    Maximum number of API calls allowed from an IP address per hour.Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 429 code is returned. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    Referers []string
    List of referrers that can perform an operation. You can use the “*” (asterisk) character as a wildcard to match subdomains, or all pages of a website. For example, "https://algolia.com/\*" matches all referrers starting with "https://algolia.com/", and "\*.algolia.com" matches all referrers ending with ".algolia.com". If you want to allow all possible referrers from the algolia.com domain, you can use "\*algolia.com/\*".
    acls List<String>
    Set of permissions associated with the key. The possible ACLs are: - search: allowed to perform search operations. - browse: allowed to retrieve all index data with the browse endpoint. - addObject: allowed to add or update a records in the index. - deleteObject: allowed to delete an existing record. - listIndexes: allowed to get a list of all existing indices. - deleteIndex: allowed to delete an index. - settings: allowed to read all index settings. - editSettings: allowed to update all index settings. - analytics: allowed to retrieve data with the Analytics API. - recommendation: allowed to interact with the Recommendation API. - usage allowed to retrieve data with the Usage API. - nluReadAnswers: allowed to perform semantic search with the Answers API. - logs: allowed to query the logs. - seeUnretrievableAttributes: allowed to retrieve unretrievableAttributes for all operations that return records.
    apiKeyId String
    description String
    Description of the API key.
    expiresAt String
    Unix timestamp of the date at which the key expires. RFC3339 format. Will not expire per default.
    indexes List<String>
    List of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the ‘*’ character. For example, “dev_*” matches all indices starting with “dev_” and “*_dev” matches all indices ending with “_dev”.
    maxHitsPerQuery Double
    Maximum number of hits this API key can retrieve in one call. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    maxQueriesPerIpPerHour Double
    Maximum number of API calls allowed from an IP address per hour.Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 429 code is returned. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    referers List<String>
    List of referrers that can perform an operation. You can use the “*” (asterisk) character as a wildcard to match subdomains, or all pages of a website. For example, "https://algolia.com/\*" matches all referrers starting with "https://algolia.com/", and "\*.algolia.com" matches all referrers ending with ".algolia.com". If you want to allow all possible referrers from the algolia.com domain, you can use "\*algolia.com/\*".
    acls string[]
    Set of permissions associated with the key. The possible ACLs are: - search: allowed to perform search operations. - browse: allowed to retrieve all index data with the browse endpoint. - addObject: allowed to add or update a records in the index. - deleteObject: allowed to delete an existing record. - listIndexes: allowed to get a list of all existing indices. - deleteIndex: allowed to delete an index. - settings: allowed to read all index settings. - editSettings: allowed to update all index settings. - analytics: allowed to retrieve data with the Analytics API. - recommendation: allowed to interact with the Recommendation API. - usage allowed to retrieve data with the Usage API. - nluReadAnswers: allowed to perform semantic search with the Answers API. - logs: allowed to query the logs. - seeUnretrievableAttributes: allowed to retrieve unretrievableAttributes for all operations that return records.
    apiKeyId string
    description string
    Description of the API key.
    expiresAt string
    Unix timestamp of the date at which the key expires. RFC3339 format. Will not expire per default.
    indexes string[]
    List of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the ‘*’ character. For example, “dev_*” matches all indices starting with “dev_” and “*_dev” matches all indices ending with “_dev”.
    maxHitsPerQuery number
    Maximum number of hits this API key can retrieve in one call. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    maxQueriesPerIpPerHour number
    Maximum number of API calls allowed from an IP address per hour.Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 429 code is returned. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    referers string[]
    List of referrers that can perform an operation. You can use the “*” (asterisk) character as a wildcard to match subdomains, or all pages of a website. For example, "https://algolia.com/\*" matches all referrers starting with "https://algolia.com/", and "\*.algolia.com" matches all referrers ending with ".algolia.com". If you want to allow all possible referrers from the algolia.com domain, you can use "\*algolia.com/\*".
    acls Sequence[str]
    Set of permissions associated with the key. The possible ACLs are: - search: allowed to perform search operations. - browse: allowed to retrieve all index data with the browse endpoint. - addObject: allowed to add or update a records in the index. - deleteObject: allowed to delete an existing record. - listIndexes: allowed to get a list of all existing indices. - deleteIndex: allowed to delete an index. - settings: allowed to read all index settings. - editSettings: allowed to update all index settings. - analytics: allowed to retrieve data with the Analytics API. - recommendation: allowed to interact with the Recommendation API. - usage allowed to retrieve data with the Usage API. - nluReadAnswers: allowed to perform semantic search with the Answers API. - logs: allowed to query the logs. - seeUnretrievableAttributes: allowed to retrieve unretrievableAttributes for all operations that return records.
    api_key_id str
    description str
    Description of the API key.
    expires_at str
    Unix timestamp of the date at which the key expires. RFC3339 format. Will not expire per default.
    indexes Sequence[str]
    List of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the ‘*’ character. For example, “dev_*” matches all indices starting with “dev_” and “*_dev” matches all indices ending with “_dev”.
    max_hits_per_query float
    Maximum number of hits this API key can retrieve in one call. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    max_queries_per_ip_per_hour float
    Maximum number of API calls allowed from an IP address per hour.Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 429 code is returned. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    referers Sequence[str]
    List of referrers that can perform an operation. You can use the “*” (asterisk) character as a wildcard to match subdomains, or all pages of a website. For example, "https://algolia.com/\*" matches all referrers starting with "https://algolia.com/", and "\*.algolia.com" matches all referrers ending with ".algolia.com". If you want to allow all possible referrers from the algolia.com domain, you can use "\*algolia.com/\*".
    acls List<String>
    Set of permissions associated with the key. The possible ACLs are: - search: allowed to perform search operations. - browse: allowed to retrieve all index data with the browse endpoint. - addObject: allowed to add or update a records in the index. - deleteObject: allowed to delete an existing record. - listIndexes: allowed to get a list of all existing indices. - deleteIndex: allowed to delete an index. - settings: allowed to read all index settings. - editSettings: allowed to update all index settings. - analytics: allowed to retrieve data with the Analytics API. - recommendation: allowed to interact with the Recommendation API. - usage allowed to retrieve data with the Usage API. - nluReadAnswers: allowed to perform semantic search with the Answers API. - logs: allowed to query the logs. - seeUnretrievableAttributes: allowed to retrieve unretrievableAttributes for all operations that return records.
    apiKeyId String
    description String
    Description of the API key.
    expiresAt String
    Unix timestamp of the date at which the key expires. RFC3339 format. Will not expire per default.
    indexes List<String>
    List of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the ‘*’ character. For example, “dev_*” matches all indices starting with “dev_” and “*_dev” matches all indices ending with “_dev”.
    maxHitsPerQuery Number
    Maximum number of hits this API key can retrieve in one call. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    maxQueriesPerIpPerHour Number
    Maximum number of API calls allowed from an IP address per hour.Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 429 code is returned. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    referers List<String>
    List of referrers that can perform an operation. You can use the “*” (asterisk) character as a wildcard to match subdomains, or all pages of a website. For example, "https://algolia.com/\*" matches all referrers starting with "https://algolia.com/", and "\*.algolia.com" matches all referrers ending with ".algolia.com". If you want to allow all possible referrers from the algolia.com domain, you can use "\*algolia.com/\*".

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiKey resource produces the following output properties:

    CreatedAt double
    The unix time at which the key has been created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    The created key.
    CreatedAt float64
    The unix time at which the key has been created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    The created key.
    createdAt Double
    The unix time at which the key has been created.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    The created key.
    createdAt number
    The unix time at which the key has been created.
    id string
    The provider-assigned unique ID for this managed resource.
    key string
    The created key.
    created_at float
    The unix time at which the key has been created.
    id str
    The provider-assigned unique ID for this managed resource.
    key str
    The created key.
    createdAt Number
    The unix time at which the key has been created.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    The created key.

    Look up Existing ApiKey Resource

    Get an existing ApiKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApiKeyState, opts?: CustomResourceOptions): ApiKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acls: Optional[Sequence[str]] = None,
        api_key_id: Optional[str] = None,
        created_at: Optional[float] = None,
        description: Optional[str] = None,
        expires_at: Optional[str] = None,
        indexes: Optional[Sequence[str]] = None,
        key: Optional[str] = None,
        max_hits_per_query: Optional[float] = None,
        max_queries_per_ip_per_hour: Optional[float] = None,
        referers: Optional[Sequence[str]] = None) -> ApiKey
    func GetApiKey(ctx *Context, name string, id IDInput, state *ApiKeyState, opts ...ResourceOption) (*ApiKey, error)
    public static ApiKey Get(string name, Input<string> id, ApiKeyState? state, CustomResourceOptions? opts = null)
    public static ApiKey get(String name, Output<String> id, ApiKeyState state, CustomResourceOptions options)
    resources:  _:    type: algolia:ApiKey    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Acls List<string>
    Set of permissions associated with the key. The possible ACLs are: - search: allowed to perform search operations. - browse: allowed to retrieve all index data with the browse endpoint. - addObject: allowed to add or update a records in the index. - deleteObject: allowed to delete an existing record. - listIndexes: allowed to get a list of all existing indices. - deleteIndex: allowed to delete an index. - settings: allowed to read all index settings. - editSettings: allowed to update all index settings. - analytics: allowed to retrieve data with the Analytics API. - recommendation: allowed to interact with the Recommendation API. - usage allowed to retrieve data with the Usage API. - nluReadAnswers: allowed to perform semantic search with the Answers API. - logs: allowed to query the logs. - seeUnretrievableAttributes: allowed to retrieve unretrievableAttributes for all operations that return records.
    ApiKeyId string
    CreatedAt double
    The unix time at which the key has been created.
    Description string
    Description of the API key.
    ExpiresAt string
    Unix timestamp of the date at which the key expires. RFC3339 format. Will not expire per default.
    Indexes List<string>
    List of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the ‘*’ character. For example, “dev_*” matches all indices starting with “dev_” and “*_dev” matches all indices ending with “_dev”.
    Key string
    The created key.
    MaxHitsPerQuery double
    Maximum number of hits this API key can retrieve in one call. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    MaxQueriesPerIpPerHour double
    Maximum number of API calls allowed from an IP address per hour.Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 429 code is returned. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    Referers List<string>
    List of referrers that can perform an operation. You can use the “*” (asterisk) character as a wildcard to match subdomains, or all pages of a website. For example, "https://algolia.com/\*" matches all referrers starting with "https://algolia.com/", and "\*.algolia.com" matches all referrers ending with ".algolia.com". If you want to allow all possible referrers from the algolia.com domain, you can use "\*algolia.com/\*".
    Acls []string
    Set of permissions associated with the key. The possible ACLs are: - search: allowed to perform search operations. - browse: allowed to retrieve all index data with the browse endpoint. - addObject: allowed to add or update a records in the index. - deleteObject: allowed to delete an existing record. - listIndexes: allowed to get a list of all existing indices. - deleteIndex: allowed to delete an index. - settings: allowed to read all index settings. - editSettings: allowed to update all index settings. - analytics: allowed to retrieve data with the Analytics API. - recommendation: allowed to interact with the Recommendation API. - usage allowed to retrieve data with the Usage API. - nluReadAnswers: allowed to perform semantic search with the Answers API. - logs: allowed to query the logs. - seeUnretrievableAttributes: allowed to retrieve unretrievableAttributes for all operations that return records.
    ApiKeyId string
    CreatedAt float64
    The unix time at which the key has been created.
    Description string
    Description of the API key.
    ExpiresAt string
    Unix timestamp of the date at which the key expires. RFC3339 format. Will not expire per default.
    Indexes []string
    List of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the ‘*’ character. For example, “dev_*” matches all indices starting with “dev_” and “*_dev” matches all indices ending with “_dev”.
    Key string
    The created key.
    MaxHitsPerQuery float64
    Maximum number of hits this API key can retrieve in one call. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    MaxQueriesPerIpPerHour float64
    Maximum number of API calls allowed from an IP address per hour.Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 429 code is returned. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    Referers []string
    List of referrers that can perform an operation. You can use the “*” (asterisk) character as a wildcard to match subdomains, or all pages of a website. For example, "https://algolia.com/\*" matches all referrers starting with "https://algolia.com/", and "\*.algolia.com" matches all referrers ending with ".algolia.com". If you want to allow all possible referrers from the algolia.com domain, you can use "\*algolia.com/\*".
    acls List<String>
    Set of permissions associated with the key. The possible ACLs are: - search: allowed to perform search operations. - browse: allowed to retrieve all index data with the browse endpoint. - addObject: allowed to add or update a records in the index. - deleteObject: allowed to delete an existing record. - listIndexes: allowed to get a list of all existing indices. - deleteIndex: allowed to delete an index. - settings: allowed to read all index settings. - editSettings: allowed to update all index settings. - analytics: allowed to retrieve data with the Analytics API. - recommendation: allowed to interact with the Recommendation API. - usage allowed to retrieve data with the Usage API. - nluReadAnswers: allowed to perform semantic search with the Answers API. - logs: allowed to query the logs. - seeUnretrievableAttributes: allowed to retrieve unretrievableAttributes for all operations that return records.
    apiKeyId String
    createdAt Double
    The unix time at which the key has been created.
    description String
    Description of the API key.
    expiresAt String
    Unix timestamp of the date at which the key expires. RFC3339 format. Will not expire per default.
    indexes List<String>
    List of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the ‘*’ character. For example, “dev_*” matches all indices starting with “dev_” and “*_dev” matches all indices ending with “_dev”.
    key String
    The created key.
    maxHitsPerQuery Double
    Maximum number of hits this API key can retrieve in one call. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    maxQueriesPerIpPerHour Double
    Maximum number of API calls allowed from an IP address per hour.Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 429 code is returned. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    referers List<String>
    List of referrers that can perform an operation. You can use the “*” (asterisk) character as a wildcard to match subdomains, or all pages of a website. For example, "https://algolia.com/\*" matches all referrers starting with "https://algolia.com/", and "\*.algolia.com" matches all referrers ending with ".algolia.com". If you want to allow all possible referrers from the algolia.com domain, you can use "\*algolia.com/\*".
    acls string[]
    Set of permissions associated with the key. The possible ACLs are: - search: allowed to perform search operations. - browse: allowed to retrieve all index data with the browse endpoint. - addObject: allowed to add or update a records in the index. - deleteObject: allowed to delete an existing record. - listIndexes: allowed to get a list of all existing indices. - deleteIndex: allowed to delete an index. - settings: allowed to read all index settings. - editSettings: allowed to update all index settings. - analytics: allowed to retrieve data with the Analytics API. - recommendation: allowed to interact with the Recommendation API. - usage allowed to retrieve data with the Usage API. - nluReadAnswers: allowed to perform semantic search with the Answers API. - logs: allowed to query the logs. - seeUnretrievableAttributes: allowed to retrieve unretrievableAttributes for all operations that return records.
    apiKeyId string
    createdAt number
    The unix time at which the key has been created.
    description string
    Description of the API key.
    expiresAt string
    Unix timestamp of the date at which the key expires. RFC3339 format. Will not expire per default.
    indexes string[]
    List of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the ‘*’ character. For example, “dev_*” matches all indices starting with “dev_” and “*_dev” matches all indices ending with “_dev”.
    key string
    The created key.
    maxHitsPerQuery number
    Maximum number of hits this API key can retrieve in one call. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    maxQueriesPerIpPerHour number
    Maximum number of API calls allowed from an IP address per hour.Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 429 code is returned. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    referers string[]
    List of referrers that can perform an operation. You can use the “*” (asterisk) character as a wildcard to match subdomains, or all pages of a website. For example, "https://algolia.com/\*" matches all referrers starting with "https://algolia.com/", and "\*.algolia.com" matches all referrers ending with ".algolia.com". If you want to allow all possible referrers from the algolia.com domain, you can use "\*algolia.com/\*".
    acls Sequence[str]
    Set of permissions associated with the key. The possible ACLs are: - search: allowed to perform search operations. - browse: allowed to retrieve all index data with the browse endpoint. - addObject: allowed to add or update a records in the index. - deleteObject: allowed to delete an existing record. - listIndexes: allowed to get a list of all existing indices. - deleteIndex: allowed to delete an index. - settings: allowed to read all index settings. - editSettings: allowed to update all index settings. - analytics: allowed to retrieve data with the Analytics API. - recommendation: allowed to interact with the Recommendation API. - usage allowed to retrieve data with the Usage API. - nluReadAnswers: allowed to perform semantic search with the Answers API. - logs: allowed to query the logs. - seeUnretrievableAttributes: allowed to retrieve unretrievableAttributes for all operations that return records.
    api_key_id str
    created_at float
    The unix time at which the key has been created.
    description str
    Description of the API key.
    expires_at str
    Unix timestamp of the date at which the key expires. RFC3339 format. Will not expire per default.
    indexes Sequence[str]
    List of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the ‘*’ character. For example, “dev_*” matches all indices starting with “dev_” and “*_dev” matches all indices ending with “_dev”.
    key str
    The created key.
    max_hits_per_query float
    Maximum number of hits this API key can retrieve in one call. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    max_queries_per_ip_per_hour float
    Maximum number of API calls allowed from an IP address per hour.Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 429 code is returned. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    referers Sequence[str]
    List of referrers that can perform an operation. You can use the “*” (asterisk) character as a wildcard to match subdomains, or all pages of a website. For example, "https://algolia.com/\*" matches all referrers starting with "https://algolia.com/", and "\*.algolia.com" matches all referrers ending with ".algolia.com". If you want to allow all possible referrers from the algolia.com domain, you can use "\*algolia.com/\*".
    acls List<String>
    Set of permissions associated with the key. The possible ACLs are: - search: allowed to perform search operations. - browse: allowed to retrieve all index data with the browse endpoint. - addObject: allowed to add or update a records in the index. - deleteObject: allowed to delete an existing record. - listIndexes: allowed to get a list of all existing indices. - deleteIndex: allowed to delete an index. - settings: allowed to read all index settings. - editSettings: allowed to update all index settings. - analytics: allowed to retrieve data with the Analytics API. - recommendation: allowed to interact with the Recommendation API. - usage allowed to retrieve data with the Usage API. - nluReadAnswers: allowed to perform semantic search with the Answers API. - logs: allowed to query the logs. - seeUnretrievableAttributes: allowed to retrieve unretrievableAttributes for all operations that return records.
    apiKeyId String
    createdAt Number
    The unix time at which the key has been created.
    description String
    Description of the API key.
    expiresAt String
    Unix timestamp of the date at which the key expires. RFC3339 format. Will not expire per default.
    indexes List<String>
    List of targeted indices. You can target all indices starting with a prefix or ending with a suffix using the ‘*’ character. For example, “dev_*” matches all indices starting with “dev_” and “*_dev” matches all indices ending with “_dev”.
    key String
    The created key.
    maxHitsPerQuery Number
    Maximum number of hits this API key can retrieve in one call. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    maxQueriesPerIpPerHour Number
    Maximum number of API calls allowed from an IP address per hour.Each time an API call is performed with this key, a check is performed. If the IP at the source of the call did more than this number of calls in the last hour, a 429 code is returned. This parameter can be used to protect you from attempts at retrieving your entire index contents by massively querying the index.
    referers List<String>
    List of referrers that can perform an operation. You can use the “*” (asterisk) character as a wildcard to match subdomains, or all pages of a website. For example, "https://algolia.com/\*" matches all referrers starting with "https://algolia.com/", and "\*.algolia.com" matches all referrers ending with ".algolia.com". If you want to allow all possible referrers from the algolia.com domain, you can use "\*algolia.com/\*".

    Import

    $ pulumi import algolia:index/apiKey:ApiKey default {{key}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    algolia k-yomo/terraform-provider-algolia
    License
    Notes
    This Pulumi package is based on the algolia Terraform Provider.
    algolia logo
    algolia 0.6.0 published on Monday, Apr 14, 2025 by k-yomo
    k-yomo/terraform-provider-algolia