Zuplo
The Zuplo Developer API, powered by Zuplo

​API Keys - Keys

Endpoint:https://dev.zuplo.com

​Lists keys

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys

​Lists keys › path Parameters

  • accountNamestring · required
  • bucketNamestring · required
  • consumerNamestring · required

​Lists keys › query Parameters

  • limitinteger · min: 1 · max: 1000 · required
  • offsetinteger · required
  • key-formatstring · enum
    Enum values:
    none
    visible
    masked

​Lists keys › Responses

    • dataobject[] · required
    • limitinteger · uint32
      Example: 1000
    • offsetinteger · uint32
    • totalinteger · uint32

​Creates an API key

POST
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys

​Creates an API key › path Parameters

  • accountNamestring · required
  • bucketNamestring · required
  • consumerNamestring · required

​Creates an API key › Request Body

  • expiresOnstring · date-time
  • descriptionstring
  • keystring

​Creates an API key › Responses

    • createdOnstring · date-time · readOnly · required
      Example: 2023-04-18T05:54:34.408Z
    • updatedOnstring · date-time · readOnly · required
      Example: 2023-04-20T05:54:34.408Z
    • idstring · readOnly · required
    • expiresOnstring · date-time
    • descriptionstring
    • keystring

​Creates multiple API keys

POST
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/$bulk

​Creates multiple API keys › path Parameters

  • accountNamestring · required
  • bucketNamestring · required
  • consumerNamestring · required

​Creates multiple API keys › Request Body

  • expiresOnstring · date-time
  • descriptionstring
  • keystring

​Creates multiple API keys › Responses

    • dataobject[] · required
    • limitinteger · uint32
      Example: 1000
    • offsetinteger · uint32
    • totalinteger · uint32

​Gets an API key

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/{keyId}

​Gets an API key › path Parameters

  • accountNamestring · required
  • bucketNamestring · required
  • consumerNamestring · required
  • keyIdstring · required

​Gets an API key › query Parameters

  • key-formatstring · enum
    Enum values:
    none
    visible
    masked
  • tagstring

​Gets an API key › Responses

    • createdOnstring · date-time · readOnly · required
      Example: 2023-04-18T05:54:34.408Z
    • updatedOnstring · date-time · readOnly · required
      Example: 2023-04-20T05:54:34.408Z
    • idstring · readOnly · required
    • expiresOnstring · date-time
    • descriptionstring
    • keystring

​Deletes an API key

DELETE
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/{keyId}

​Deletes an API key › path Parameters

  • accountNamestring · required
  • bucketNamestring · required
  • consumerNamestring · required
  • keyIdstring · required

​Deletes an API key › query Parameters

  • tagstring

​Deletes an API key › Responses

    No schema specified

​Updates an API key

PATCH
https://dev.zuplo.com
/v1/accounts/{accountName}/key-buckets/{bucketName}/consumers/{consumerName}/keys/{keyId}

​Updates an API key › path Parameters

  • accountNamestring · required
  • bucketNamestring · required
  • consumerNamestring · required
  • keyIdstring · required

​Updates an API key › query Parameters

  • tagstring

​Updates an API key › Request Body

  • expiresOnstring · date-time
  • descriptionstring
  • keystring

​Updates an API key › Responses

    • createdOnstring · date-time · readOnly · required
      Example: 2023-04-18T05:54:34.408Z
    • updatedOnstring · date-time · readOnly · required
      Example: 2023-04-20T05:54:34.408Z
    • idstring · readOnly · required
    • expiresOnstring · date-time
    • descriptionstring
    • keystring
VariablesAPI Keys - Consumers