Sign in

v1

latestOpenAPI 3.0.32026-08-068925782.3 MB
Assets

Requests endpoints allows the creation of different kind of requests to handle the life cycle of Assets.

get/requests

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

activation_keystring

This filter is used for explicit negative select. For example, select(-activation_key). It will not return "activation_key" property in the response. Combining it together with select(-template), i.e. doing select(-activation_key,-template), may dramatically increase /requests API performance. Please consider using those two negative selects if in your application you do not need to treat neither "activation_key" field nor "template" object.

lookups:

asset.account_idstring

Filter for: asset.account_id

lookups: eq

asset.configurationstring

This filter is used for explicit negative select. For example, select(-configuration). It will not return "configuration" object in the response. Please consider using this negative select if in your application you do not need to treat "configuration" object, it may dramatically increase /requests API performance.

lookups:

asset.connection.environment'test' | 'production'

Filter for: asset.connection.environment

lookups: eq, in

asset.connection.hub.idstring

Filter for: asset.connection.hub.id

lookups: eq, ne, like, ilike, null, in, out

null: HB-0000-0000, null()

asset.connection.hub.namestring

Filter for: asset.connection.hub.name

lookups: eq, ne, like, ilike, in, out

ordering: true

asset.connection.idstring

Filter for: asset.connection.id

lookups: eq, ne, like, ilike, null, in, out

null: CT-0000-0000-0000, null()

asset.connection.provider.idstring

Filter for: asset.connection.provider.id

lookups: eq, ilike, in

asset.connection.provider.namestring

Filter for: asset.connection.provider.name

lookups: eq, ilike

asset.connection.type'test' | 'production'

Filter for: asset.connection.type

lookups: eq, in

asset.connection.vendor.idstring

Filter for: asset.connection.vendor.id

lookups: eq, ilike, in

asset.connection.vendor.namestring

Filter for: asset.connection.vendor.name

lookups: eq, ilike

asset.contract.idstring

Filter for: asset.contract.id

lookups: eq, ne, like, ilike, null, in, out

null: CRD-00000-00000-00000, null()

asset.external.idstring

Filter for: asset.external.id

lookups: eq, ne, like, ilike, null, in, out

asset.external_idstring

Filter for: asset.external_id

lookups: eq, ne, like, ilike, null, in, out

asset.external_uidstring

Filter for: asset.external_uid

lookups: eq, ne, like, ilike, null, in, out

asset.idstring

Filter for: asset.id

lookups: eq, ne, like, ilike, null, in, out

asset.itemsstring

This filter is used for explicit negative select. For example, select(-items). It will not return "items" list in the response. Please consider using this negative select if in your application you do not need to treat "items" list, it may dramatically increase /requests API performance.

lookups:

asset.marketplace.idstring

Filter for: asset.marketplace.id

lookups: eq, ne, like, ilike, null, in, out

null: MP-00000, null()

asset.marketplace.namestring

Filter for: asset.marketplace.name

lookups: eq, ne, like, ilike, in, out

ordering: true

asset.params.idstring

Filter for: asset.params.id

lookups: eq, in

asset.params.valuestring

Filter for: asset.params.value

lookups: eq, in

asset.product.capabilitiesstring

This filter is used for explicit select. For example, select(asset.product.capabilities). It will return additionally product capabilities in the response.

lookups:

default: hidden

asset.product.idstring

Filter for: asset.product.id

lookups: eq, ne, like, ilike, null, in, out

asset.product.namestring

Filter for: asset.product.name

lookups: eq, ne, like, ilike, in, out

ordering: true

asset.status'draft' | 'processing' | 'active' | 'terminating' | 'suspended' | 'terminated'

Filter for: asset.status

lookups: eq

asset.tier1_idstring

Filter for: asset.tier1_id

lookups: eq

asset.tier2_idstring

Filter for: asset.tier2_id

lookups: eq

asset.tiers.customer.idstring

Filter for: asset.tiers.customer.id

lookups: eq, ne, like, ilike, null, in, out

ordering: true

asset.tiers.customer.namestring

Filter for: asset.tiers.customer.name

lookups: eq, ne, like, ilike, null, in, out

ordering: true

asset.tiers.tier1.idstring

Filter for: asset.tiers.tier1.id

lookups: eq, ne, like, ilike, null, in, out

asset.tiers.tier2string

Filter for: asset.tiers.tier2

lookups: eq

asset.tiers.tier2.idstring

Filter for: asset.tiers.tier2.id

lookups: eq, ne, like, ilike, null, in, out

asset__connection__environment'test' | 'production'

Filter for: asset__connection__environment

lookups: eq, in

asset__connection__hub__idstring

Filter for: asset__connection__hub__id

lookups: eq

asset__connection__hub__namestring

Filter for: asset__connection__hub__name

lookups: eq, ne, like, ilike, in, out

ordering: true

asset__connection__provider__idstring

Filter for: asset__connection__provider__id

lookups: eq, ilike, in

asset__connection__provider__namestring

Filter for: asset__connection__provider__name

lookups: eq, ilike

asset__connection__type'test' | 'production'

Filter for: asset__connection__type

lookups: eq, in

asset__connection__vendor__idstring

Filter for: asset__connection__vendor__id

lookups: eq, ilike, in

asset__connection__vendor__namestring

Filter for: asset__connection__vendor__name

lookups: eq, ilike

asset__idstring

Filter for: asset__id

lookups: eq, ne, like, ilike, null, in, out

asset__product__idstring

Filter for: asset__product__id

lookups: eq, ne, like, ilike, null, in, out

asset__product__namestring

Filter for: asset__product__name

lookups: eq, ne, like, ilike, in, out

ordering: true

asset__tiers__customer__idstring

Filter for: asset__tiers__customer__id

lookups: eq

ordering: true

asset__tiers__tier1__idstring

Filter for: asset__tiers__tier1__id

lookups: eq

asset__tiers__tier2__idstring

Filter for: asset__tiers__tier2__id

lookups: eq

asset_idstring

Filter for: asset_id

lookups: eq, in

assigneestring

Filter for: assignee

lookups: eq, null, in

assignee.emailstring

Filter for: assignee.email

lookups: eq, ilike, in

assignee__emailstring

Filter for: assignee__email

lookups: eq, ilike, in

contract.idstring

Filter for: contract.id

lookups: eq, ne, like, ilike, null, in, out

null: CRD-00000-00000-00000, null()

contract__idstring

Filter for: contract__id

lookups: eq, ne, like, ilike, null, in, out

null: CRD-00000-00000-00000, null()

contract__id__exactstring

Filter for: contract__id__exact

lookups: eq

createdstring date-time

Filter for: created

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

external_idstring

Filter for: external_id

lookups: eq, ne, like, ilike, null, in, out

search: true

idstring

Filter for: id

lookups: eq, ne, like, ilike, null, in, out

marketplace.idstring

Filter for: marketplace.id

lookups: eq, ne, like, ilike, null, in, out

null: MP-00000, null()

marketplace.namestring

Filter for: marketplace.name

lookups: eq, ne, like, ilike, in, out

ordering: true

marketplace__namestring

Filter for: marketplace__name

lookups: eq, ne, like, ilike, in, out

ordering: true

product_idstring

Filter for: product_id

lookups: eq, ne, like, ilike, null, in, out

sli.daysinteger

Filter for: sli.days

lookups: eq, ge, gt, le, lt

ordering: true

sli.zoneinteger

Filter for: sli.zone

lookups: eq, ne, ge, gt, le, lt, null, in, out

ordering: true

status'draft' | 'tiers_setup' | 'pending' | 'inquiring' | 'approved' | 'failed' | 'scheduled' | 'revoking' | 'revoked' | 'queued'

Filter for: status

lookups: eq, ne, like, ilike, in, out

ordering: true

templatestring

This filter is used for explicit negative select. For example, select(-template). It will not return "template" object in the response. Combining it together with select(-activation_key), i.e. doing select(-activation_key,-template), may dramatically increase /requests API performance. Please consider using those two negative selects if in your application you do not need to treat neither "activation_key" field nor "template" object.

lookups:

template.idstring

Filter for: template.id

lookups: eq, ne, like, ilike, null, in, out

type'purchase' | 'cancel' | 'change' | 'suspend' | 'resume' | 'adjustment' | 'renew' | 'transfer'

Filter for: type

lookups: eq, ne, like, ilike, in, out

updatedstring date-time

Filter for: updated

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

Response

idstring
type'purchase' | 'change' | 'suspend' | 'resume' | 'cancel'
notestring
reasonstring
createdstring datetime
updatedstring datetime
effective_datestring datetime
answeredboolean
assigneestring
activation_keystring
status'draft' | 'tiers_setup' | 'pending' | 'inquiring' | 'approved' | 'failed'