RIrilldata

GetDeployment returns runtime info and access token on behalf of a specific user, or alternatively for a raw set of JWT attributes

Changed on
post/v1/deployments/{deploymentId}/credentials

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

deploymentIdstring required

ID of the deployment to get credentials for.

Request body

accessTokenTtlSecondsinteger

Optional TTL for the returned access token in seconds.

attributesobject

If set, will use the provided attributes outright.

externalUserIdstring

Optional ID for an external end user of the deployment. If set, the access token enables per-user state, such as AI chat history. Cannot be combined with user_id. If user_email matches a Rill Cloud user, their attributes are used, but this ID takes precedence for per-user state.

superuserForceAccessboolean

If true, superusers can access the deployment even without org/project membership.

userEmailstring

If set, will generate attributes corresponding to a user with this email.

userIdstring

If set, will use the attributes of the Rill user with this ID.

Response

A successful response.

accessTokenstring
instanceIdstring
runtimeHoststring
ttlSecondsinteger

Changes