Skip to main content
GET
Get a resource

Authorizations

Authorization
string
header
required

Monid API key (Authorization: Bearer mk_...) or Clerk-issued JWT. Each operation lists the ONE scope an API key needs. {resource}:* grants every action on that resource; * grants everything; Clerk sessions hold *. Operations with an empty list need no scope. Scope catalog: GET /v1/api-keys/scopes.

Headers

X-Monid-Agent-Model
string

Model driving the calling agent. Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

Maximum string length: 256
X-Monid-Agent-Harness
string

Agent harness or client making the call (e.g. a coding agent, an agent framework). Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

Maximum string length: 256
X-Monid-Agent-Session-Id
string

Caller-side session identifier, so the calls of one agent session (discover → inspect → run → polling) can be correlated. Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

Maximum string length: 256

Path Parameters

resourceId
string
required

Resource identifier (ULID).

Response

The resource

resourceId
string
required

Resource identifier (ULID).

provider
string
required
resourceSlug
string
required
resourceType
string
required
externalId
string
required
identifier
string
required
releasable
boolean
required
state
enum<string>
required

Lifecycle state.

Available options:
READY,
PROVISIONING,
ACTIVE,
EXPIRING,
SUSPENDED,
RELEASED,
PROVISION_FAILED
provisionedBy
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
providerName
string
displayName
string

Resource display name (e.g. "Machine").

description
string

Short one-line description.

summary
string

Detailed description.

releasedBy
string
renewal
object
releasedAt
string<date-time>
releaseReasonCode
string
releaseReason
string
phoneNumber
string
country
string
numberType
string
name
string
totalBytes
integer
objectCount
integer
lastMutationAt
string<date-time>
expiresAt
string
ttl
number
activityTtl
number
profileId
string
profileSaveChanges
boolean
liveViewUrl
string
interactiveLiveViewUrl
string
cdpUrl
string
baseUrl
string
targetUrl
string
timeoutSeconds
integer
proxyCountryCode
string
externalResources
object[]
syncedAt
string<date-time>
usageBilling
object

Metered usage pricing (absent for rent-only resources).