Zuplo
The Zuplo Developer API, powered by Zuplo

​API Keys - Buckets

Endpoint:https://dev.zuplo.com

​Lists buckets

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

​Lists buckets › path Parameters

  • accountNamestring · required

​Lists buckets › Responses

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

​Creates a bucket

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

​Creates a bucket › path Parameters

  • accountNamestring · required

​Creates a bucket › Request Body

  • namestring · pattern: ^[a-z0-9-]{5,128}$ · required
  • descriptionstring
  • tagsobject

​Creates a bucket › 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
    • namestring · pattern: ^[a-z0-9-]{5,128}$ · required
    • isRetrievableboolean
    • descriptionstring
    • tagsobject

​Gets a bucket

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

​Gets a bucket › path Parameters

  • accountNamestring · required
  • bucketNamestring · required

​Gets a bucket › 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
    • namestring · pattern: ^[a-z0-9-]{5,128}$ · required
    • isRetrievableboolean
    • descriptionstring
    • tagsobject

​Deletes a bucket

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

​Deletes a bucket › path Parameters

  • accountNamestring · required
  • bucketNamestring · required

​Deletes a bucket › Responses

    No schema specified

​Updates a bucket

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

​Updates a bucket › path Parameters

  • accountNamestring · required
  • bucketNamestring · required

​Updates a bucket › Request Body

  • descriptionstring
  • tagsobject

​Updates a bucket › 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
    • namestring · pattern: ^[a-z0-9-]{5,128}$ · required
    • isRetrievableboolean
    • descriptionstring
    • tagsobject
API Keys - ConsumersOther endpoints