Get one workload's identity

post

https://api.doit.com/attribute/v1/workloads/w/details

Decodes a workloadId into the workload's name, type, namespace, cluster and account. It
reads no cost data and takes no date range. Use it to show which workload a workloadId
names. Get a workloadId from a workload row of queryAttributeWorkloadsTable. An ID that
does not decode returns 404.

Authenticate with Authorization: Bearer <token>. Omit X-Tenant-Id when the credential
resolves to one customer. When the credential can act on several customers, send
X-Tenant-Id: <tenant-id> to select one.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

workloadId

string

required

length ≥ 1

Opaque ID of one workload. Copy it unchanged from the workloadId of a workload row of
queryAttributeWorkloadsTable; do not build or change it. An ID that does not decode
returns 404.

Headers

X-Tenant-Id

string

Customer (tenant) ID for the request. This is separate from authentication: you still pass your personal or service account API token in the Authorization header (Bearer <token>). See Get Started.

When to omit (most callers): If your personal or service account token belongs to a single customer, omit this header. The API resolves that customer from the token.

When to send: If your credential can access more than one customer, set X-Tenant-Id to the customer ID you want to act on. A service account can select an active direct or nested descendant of its home customer; the endpoint's normal permissions, entitlements, and resource-ownership checks still apply. A service-account target outside that customer subtree returns 403 Forbidden. Prefer this header over the legacy customerContext query parameter, which only applies to legacy API keys and is ignored by personal and service account tokens.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200OK - The workload's key fields.

401Unauthorized - The Authorization: Bearer <token> header is missing, the token is not valid, or the person behind the token has no email address. Code: unauthorized.

404Not Found - route_not_found when the path or HTTP method is not one of the Attribute Workloads operations. not_found when the workloadId does not decode: copy it unchanged from a workload row of queryAttributeWorkloadsTable.

409Conflict - The customer is not set up in Attribute yet (attribute_customer_not_provisioned) or its Attribute setup needs a fix by DoiT (attribute_tenant_reconciliation_required). Retrying does not help; contact DoiT support.

500Internal Server Error - Unexpected error in the Attribute service (upstream_error). Retry with backoff.

502Bad Gateway - A service behind the gateway did not answer: token check (auth_unavailable) or the Attribute service (upstream_unavailable), or the Attribute service refused the gateway (upstream_error). Retry with backoff.

503Service Unavailable - The Attribute integration is turned off (integration_disabled), the token check is unavailable (auth_unavailable), or the permission check is unavailable (authorization_unavailable). Retry later.