Zuplo
The Zuplo Developer API, powered by Zuplo

​API Keys - Consumers

Endpoint:https://dev.zuplo.com

​Lists consumers

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

​Lists consumers › path Parameters

  • accountNamestring · required
  • bucketNamestring · required

​Lists consumers › query Parameters

  • limitinteger · min: 1 · max: 1000 · required
  • offsetinteger · required
  • include-api-keysboolean
  • include-manager-invitesboolean
  • include-managersboolean
  • key-formatstring · enum
    Enum values:
    none
    visible
    masked
  • manager-emailstring
  • tagstring

​Lists consumers › Responses

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

​Creates a consumer

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

​Creates a consumer › path Parameters

  • accountNamestring · required
  • bucketNamestring · required

​Creates a consumer › query Parameters

  • with-api-keyboolean

​Creates a consumer › Request Body

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

​Creates a consumer › 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-]{1,128}$ · required
    • apiKeysobject[]
    • descriptionstring
    • tagsobject
    • metadataobject

​Gets a consumer

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

​Gets a consumer › path Parameters

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

​Gets a consumer › query Parameters

  • include-api-keysboolean
  • key-formatstring · enum
    Enum values:
    none
    visible
    masked
  • include-managersboolean
  • include-manager-invitesboolean
  • tagstring

​Gets a consumer › 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-]{1,128}$ · required
    • apiKeysobject[]
    • descriptionstring
    • tagsobject
    • metadataobject

​Deletes a consumer

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

​Deletes a consumer › path Parameters

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

​Deletes a consumer › query Parameters

  • tagstring

​Deletes a consumer › Responses

    No schema specified

​Updates a consumer

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

​Updates a consumer › path Parameters

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

​Updates a consumer › query Parameters

  • tagstring

​Updates a consumer › Request Body

  • descriptionstring
  • tagsobject
  • metadataobject

​Updates a consumer › 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-]{1,128}$ · required
    • apiKeysobject[]
    • descriptionstring
    • tagsobject
    • metadataobject

​Roll consumer keys

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

​Roll consumer keys › path Parameters

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

​Roll consumer keys › query Parameters

  • tagstring

​Roll consumer keys › Request Body

  • expiresOnstring · date-time · required
    Example: 2050-04-18T05:54:34.408Z

​Roll consumer keys › Responses

    No schema specified
API Keys - KeysAPI Keys - Buckets