The Zuplo Developer API, powered by Zuplo

API Keys - Keys

Endpoint:https://dev.zuplo.com

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

GET

https://dev.zuplo.com

/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys

Lists all keys for this consumer.

Lists keys › path Parameters

accountNamestring · required
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · required
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNamestring · required
The name of the consumer.

Lists keys › query Parameters

limitinteger · min: 1 · max: 1000 · required
The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. Default: 1000
offsetinteger · min: 0 · required
The offset of the first item returned in the collection. Default: 0
key-formatstring · enum
The format of the key to return. none: Key is completely hidden. visible: Key is completely visible. masked: Part of key suffix is visible.
Enum values:
none
visible
masked

Lists keys › Responses

The request has succeeded.

dataobject[] · required

limitinteger · uint32
Example: 1000
offsetinteger · uint32
Example: 0
totalinteger · uint32

Creates an API key

POST

https://dev.zuplo.com

/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys

Creates a new API key for this consumer. New API keys will automatically have API Key Leak Detection enabled.

Creates an API key › path Parameters

accountNamestring · required
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · required
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNamestring · required
The name of the consumer.

Creates an API key › Request Body

expiresOnstring · date-time
When the key expires.
descriptionstring
The description of the api key.
keystring
The 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.

createdOnstring · date-time · readOnly · required
When the item was created.
Example: 2023-04-18T05:54:34.408Z
updatedOnstring · date-time · readOnly · required
When the item was last updated.
Example: 2023-04-20T05:54:34.408Z
idstring · readOnly · required

expiresOnstring · date-time
When the key expires.
descriptionstring
The description of the api key.
keystring
The 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

POST

https://dev.zuplo.com

/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/$bulk

Creates multiple new API keys for this consumer.

Creates multiple API keys › path Parameters

accountNamestring · required
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · required
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNamestring · required
The name of the consumer.

Creates multiple API keys › Request Body

expiresOnstring · date-time
When the key expires.
descriptionstring
The description of the api key.
keystring
The 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.

dataobject[] · required

limitinteger · uint32
Example: 1000
offsetinteger · uint32
Example: 0
totalinteger · uint32

Gets an API key

GET

https://dev.zuplo.com

/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/{keyId}

Retrieves an API key for this consumer.

Gets an API key › path Parameters

accountNamestring · required
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · required
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNamestring · required
The name of the consumer.
keyIdstring · required
The key id.

Gets an API key › query Parameters

key-formatstring · enum
The format of the key to return. none: Key is completely hidden. visible: Key is completely visible. masked: Part of key suffix is visible.
Enum values:
none
visible
masked
tagstring
Query 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.

createdOnstring · date-time · readOnly · required
When the item was created.
Example: 2023-04-18T05:54:34.408Z
updatedOnstring · date-time · readOnly · required
When the item was last updated.
Example: 2023-04-20T05:54:34.408Z
idstring · readOnly · required

expiresOnstring · date-time
When the key expires.
descriptionstring
The description of the api key.
keystring
The 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

DELETE

https://dev.zuplo.com

/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/{keyId}

Deletes an API key for this consumer.

Deletes an API key › path Parameters

accountNamestring · required
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · required
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNamestring · required
The name of the consumer.
keyIdstring · required
The key id.

Deletes an API key › query Parameters

tagstring
Query 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.

No data returned

Updates an API key

PATCH

https://dev.zuplo.com

/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/{keyId}

Updates an API key for this consumer.

Updates an API key › path Parameters

accountNamestring · required
The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.
bucketNamestring · required
The name of the bucket. Zuplo automatically creates a bucket for your project. You can find it in youe Zuplo Portal under Settings > Project Information.
consumerNamestring · required
The name of the consumer.
keyIdstring · required
The key id.

Updates an API key › query Parameters

tagstring
Query 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

expiresOnstring · date-time
When the key expires.
descriptionstring
The description of the api key.
keystring
The 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.

createdOnstring · date-time · readOnly · required
When the item was created.
Example: 2023-04-18T05:54:34.408Z
updatedOnstring · date-time · readOnly · required
When the item was last updated.
Example: 2023-04-20T05:54:34.408Z
idstring · readOnly · required

expiresOnstring · date-time
When the key expires.
descriptionstring
The description of the api key.
keystring
The 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

Variables API Keys - Consumers