This is an object representing an API key. This section includes a list of endpoints to perform CRUD operations on an API key. You can learn more about API keys here.
Lists keys
Lists all keys for this consumer.
path Parameters
accountNameThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNameThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNameThe name of the consumer.
query Parameters
limitThe maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000
offsetThe offset of the first item returned in the collection. Default: 0
key-formatThe format of the key to return.
none: Key is completely hidden.
visible: Key is completely visible.
masked: Part of key suffix is visible.
Lists keys › Responses
The request has succeeded.
limitoffsettotalCreates an API key
Creates a new API key for this consumer. New API keys will automatically have API Key Leak Detection enabled.
path Parameters
accountNameThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNameThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNameThe name of the consumer.
Creates an API key › Request Body
expiresOnWhen the key expires.
descriptionThe description of the api key.
keyThe API key's value. You can use this parameter to override Zuplo's default key format, but this is not recommended as you will lose our API Key Leak Detection
Creates an API key › Responses
The request has succeeded.
createdOnWhen the item was created.
updatedOnWhen the item was last updated.
idexpiresOnWhen the key expires.
descriptionThe description of the api key.
keyThe API key's value. You can use this parameter to override Zuplo's default key format, but this is not recommended as you will lose our API Key Leak Detection
Creates multiple API keys
Creates multiple new API keys for this consumer.
path Parameters
accountNameThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNameThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNameThe name of the consumer.
Creates multiple API keys › Request Body
expiresOnWhen the key expires.
descriptionThe description of the api key.
keyThe API key's value. You can use this parameter to override Zuplo's default key format, but this is not recommended as you will lose our API Key Leak Detection
Creates multiple API keys › Responses
The request has succeeded.
limitoffsettotalGets an API key
Retrieves an API key for this consumer.
path Parameters
accountNameThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNameThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNameThe name of the consumer.
keyIdThe key id.
query Parameters
key-formatThe format of the key to return.
none: Key is completely hidden.
visible: Key is completely visible.
masked: Part of key suffix is visible.
tagQuery by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.
Gets an API key › Responses
The request has succeeded.
createdOnWhen the item was created.
updatedOnWhen the item was last updated.
idexpiresOnWhen the key expires.
descriptionThe description of the api key.
keyThe API key's value. You can use this parameter to override Zuplo's default key format, but this is not recommended as you will lose our API Key Leak Detection
Deletes an API key
Deletes an API key for this consumer.
path Parameters
accountNameThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNameThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNameThe name of the consumer.
keyIdThe key id.
query Parameters
tagQuery by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.
Deletes an API key › Responses
There is no content to send for this request, but the headers may be useful.
Updates an API key
Updates an API key for this consumer.
path Parameters
accountNameThe name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNameThe name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNameThe name of the consumer.
keyIdThe key id.
query Parameters
tagQuery by tag. Example usage is tag.account=foo, where account is the name of the tag property and foo is the value.
Updates an API key › Request Body
expiresOnWhen the key expires.
descriptionThe description of the api key.
keyThe API key's value. You can use this parameter to override Zuplo's default key format, but this is not recommended as you will lose our API Key Leak Detection
Updates an API key › Responses
The request has succeeded.
createdOnWhen the item was created.
updatedOnWhen the item was last updated.
idexpiresOnWhen the key expires.
descriptionThe description of the api key.
keyThe API key's value. You can use this parameter to override Zuplo's default key format, but this is not recommended as you will lose our API Key Leak Detection