Docs
Reference

Mint one dynamic credential

Asks the engine behind a dynamic address for a fresh credential and hands it back once.

POST/api/v1/dynamic/{address}/lease

Asks the engine behind a dynamic address for a fresh credential and hands it back once. Call it at run time, because a lease minted at build time would already have expired. The environment has to have the lease API turned on, and it is off until someone turns it on.

AuthorizationBearer <token>

A machine credential, sent as Authorization: Bearer pck_.... Issue one from the console, or get a short-lived one from an exchange under auth.

In: header

Path Parameters

address*string

The dynamic parameter's address. The last segment is the name and everything before it is the path, so slashes are part of the address and are not escaped. The literal lease segment follows it in the URL.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

How long the credential should live. Leave it out to take the engine's own default, which is what most callers want.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/dynamic/aws/DEPLOY_ROLE/lease" \  -H "Content-Type: application/json" \  -d '{}'
{  "credential": {    "property1": "string",    "property2": "string"  },  "lease": {    "id": "string",    "engine": "string",    "remoteIdentity": "string",    "issuedAt": "2019-08-24T14:15:22Z",    "expiresAt": "2019-08-24T14:15:22Z",    "revocation": "per-lease"  }}