Resource Claims

Claim Resource

Claim a resource for a subscription. Exactly one of quantity, externalId, or externalIds must be provided.

post/api/v1/resource-claims/{subscriptionId}/claim

Path parameters

subscriptionIdstring required

Request body

resourceSlugstring required

The slug of the resource to claim

metadataMetadata

JSON object

quantityinteger

Create N anonymous claims without external identifiers.

externalIdstring

Create a single named claim with this external identifier (idempotent).

externalIdsstring[]

Create multiple named claims with these external identifiers (idempotent per ID).

Response

Successful response

Changes

Changed in 2 of the 43 revisions of this API.3

    • added the required property usage/resourceId to the response with the 200 status

      response-required-property-added

    • added the required property usage/resourceSlug to the response with the 200 status

      response-required-property-added

    • endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog