ApiKey class final

Annotations
  • @JsonSerializable()

Constructors

ApiKey({required List<Acl> acl, String? description, List<String>? indexes, int? maxHitsPerQuery, int? maxQueriesPerIPPerHour, String? queryParameters, List<String>? referers, int? validity})
Returns a new ApiKey instance.
const
ApiKey.fromJson(Map<String, dynamic> json)
factory

Properties

acl List<Acl>
Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see access control list.
final
description String?
Description of an API key to help you identify this API key.
final
hashCode int
The hash code for this object.
no setteroverride
indexes List<String>?
Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (*): - dev_* matches all indices starting with "dev_". - *_dev matches all indices ending with "_dev". - *_products_* matches all indices containing "products".
final
maxHitsPerQuery int?
Maximum number of results this API key can retrieve in one query. By default, there's no limit.
final
maxQueriesPerIPPerHour int?
Maximum number of API requests allowed per IP address or user token per hour. If this limit is reached, the API returns an error with status code 429. By default, there's no limit.
final
queryParameters String?
Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the restrictSources parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address outside the restricted range.
final
referers List<String>?
Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (*): - https://algolia.com/_* allows all referrers starting with "https://algolia.com/" - *.algolia.com allows all referrers ending with ".algolia.com" - *algolia.com* allows all referrers in the domain "algolia.com". Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data. For more information, see HTTP referrer restrictions.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
validity int?
Duration (in seconds) after which the API key expires. By default, API keys don't expire.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
override