Lease

POST/api/v1/leases/resources

Create_resource

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

display_name*string

Human-friendly display name

fsm_requirements?array<>

FSM transitions that require a live lease before executing

kind*string

Resource kind (e.g. world_instance, compute_slot)

lease_policy?null|

metadata?unknown

Arbitrary resource metadata

`application/json`

curl -X POST "https://example.com/api/v1/leases/resources" \  -H "Content-Type: application/json" \  -d '{    "display_name": "string",    "kind": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "display_name": "string",  "kind": "string",  "resource_id": "string"}

GET/api/v1/leases/resources/{resource_id}

Get_resource

Authorization

bearer_token

AuthorizationBearer <token>

In: header

`application/json`

curl -X GET "https://example.com/api/v1/leases/resources/string"

{  "active_leases": [    {      "expires_at": "2019-08-24T14:15:22Z",      "fencing_token": 0,      "holder": {        "id": "string",        "kind": "user"      },      "lease_id": "string",      "mode": "exclusive",      "status": "pending",      "units": 0    }  ],  "bookings": [    {      "booking_id": "string",      "ends_at": "2019-08-24T14:15:22Z",      "holder_id": "string",      "mode": "exclusive",      "starts_at": "2019-08-24T14:15:22Z",      "status": "scheduled"    }  ],  "resource": {    "created_at": "2019-08-24T14:15:22Z",    "display_name": "string",    "kind": "string",    "lease_policy": {      "default_duration_seconds": 0,      "fractional": {        "enabled": true,        "total_units": 0      },      "lifetime_cap_seconds": 0,      "max_duration_seconds": 0,      "renewal_grace_seconds": 0,      "shared_modes": [        "exclusive"      ],      "transferable": true    },    "metadata": null,    "resource_id": "string",    "status": "available"  },  "wait_count": 0}

POST/api/v1/leases/{resource_id}/acquire

Acquire_lease

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

duration_seconds?|

Requested lease duration in seconds (defaults to policy/config default)

Formatint64

Range0 <= value

idempotency_key?|

Idempotency key to return the original lease result on retries

metadata?unknown

Arbitrary lease metadata (purpose, request id, etc.)

mode?null|

on_conflict?null|

priority?|

Optional waiting-room priority when on_conflict = join_waiting_room

Formatdouble

units?|

Number of fractional units to acquire (defaults to 1)

Formatint32

Range0 <= value

`application/json`

curl -X POST "https://example.com/api/v1/leases/string/acquire" \  -H "Content-Type: application/json" \  -d '{}'

{  "expires_at": "2019-08-24T14:15:22Z",  "fencing_token": 0,  "lease_id": "string",  "mode": "exclusive",  "resource_id": "string",  "status": "pending",  "waiting_position": 0}

GET/api/v1/leases/{resource_id}/bookings

List_bookings

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Conditions as filter[][]=. Conditions on different fields all apply. in (any of) and all (every one of, on fields holding several values) take a comma-separated list (\, for a literal comma). exists takes true or false. Datetimes are RFC 3339, now, or a time before now such as -30m, -6h or -7d.

sort?string

Comma-separated sort keys, - for descending, at most 1. Keys: starts_at. Default: starts_at.

limit?integer

Rows per page, 1 to 100 (default 25).

Range1 <= value <= 100

cursor?string

The page.next_cursor of the previous page. Cannot be combined with page.

page?integer

A 1-based page number, for jumping. Cannot be combined with cursor.

Range1 <= value

total?boolean

Set to true to include the number of matching rows in page.total.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/leases/string/bookings"

{  "bookings": [    {      "booking_id": "string",      "ends_at": "2019-08-24T14:15:22Z",      "holder_id": "string",      "mode": "exclusive",      "starts_at": "2019-08-24T14:15:22Z",      "status": "scheduled"    }  ],  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  },  "resource_id": "string"}

POST/api/v1/leases/{resource_id}/bookings

Create_booking

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

ends_at*string

Booking end time

Formatdate-time

mode?null|

starts_at*string

Booking start time

Formatdate-time

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/leases/string/bookings" \  -H "Content-Type: application/json" \  -d '{    "ends_at": "2019-08-24T14:15:22Z",    "starts_at": "2019-08-24T14:15:22Z"  }'

{  "booking_id": "string",  "ends_at": "2019-08-24T14:15:22Z",  "resource_id": "string",  "starts_at": "2019-08-24T14:15:22Z",  "status": "scheduled"}

DELETE/api/v1/leases/{resource_id}/bookings/{booking_id}

Cancel_booking

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

booking_id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/leases/string/bookings/string"

{  "booking_id": "string",  "resource_id": "string",  "status": "scheduled"}

GET/api/v1/leases/{resource_id}/history

List_history

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Query Parameters

filter?

sort?string

Comma-separated sort keys, - for descending, at most 1. Keys: occurred_at. Default: -occurred_at.

limit?integer

Rows per page, 1 to 100 (default 25).

Range1 <= value <= 100

cursor?string

The page.next_cursor of the previous page. Cannot be combined with page.

page?integer

A 1-based page number, for jumping. Cannot be combined with cursor.

Range1 <= value

total?boolean

Set to true to include the number of matching rows in page.total.

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/leases/string/history"

{  "history": [    {      "actor_id": "string",      "event": "acquired",      "fencing_token": 0,      "from_status": null,      "history_id": "string",      "lease_id": "string",      "metadata": null,      "occurred_at": "2019-08-24T14:15:22Z",      "resource_id": "string",      "to_status": "pending"    }  ],  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  }}

POST/api/v1/leases/{resource_id}/release

Release_lease

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

fencing_token*integer

Fencing token presented by the holder

Formatint64

Range0 <= value

lease_id*string

Lease ID to release

metadata?unknown

Optional termination metadata

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/leases/string/release" \  -H "Content-Type: application/json" \  -d '{    "fencing_token": 0,    "lease_id": "string"  }'

{  "admitted_waiter": "string",  "lease_id": "string",  "message": "string",  "resource_id": "string"}

POST/api/v1/leases/{resource_id}/renew

Renew_lease

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

duration_seconds*integer

Additional duration in seconds to extend the lease by

Formatint64

Range0 <= value

fencing_token*integer

Fencing token presented by the holder

Formatint64

Range0 <= value

lease_id*string

Lease ID to renew

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/leases/string/renew" \  -H "Content-Type: application/json" \  -d '{    "duration_seconds": 0,    "fencing_token": 0,    "lease_id": "string"  }'

{  "expires_at": "2019-08-24T14:15:22Z",  "lease_id": "string",  "resource_id": "string",  "status": "pending"}

GET/api/v1/leases/{resource_id}/status

Lease_status

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/leases/string/status"

{  "active_leases": [    {      "expires_at": "2019-08-24T14:15:22Z",      "fencing_token": 0,      "holder": {        "id": "string",        "kind": "user"      },      "lease_id": "string",      "mode": "exclusive",      "status": "pending",      "units": 0    }  ],  "bookings": [    {      "booking_id": "string",      "ends_at": "2019-08-24T14:15:22Z",      "holder_id": "string",      "mode": "exclusive",      "starts_at": "2019-08-24T14:15:22Z",      "status": "scheduled"    }  ],  "caller_lease_id": "string",  "capacity": 0,  "resource_id": "string",  "resource_status": "available",  "wait_count": 0}

POST/api/v1/leases/{resource_id}/transfer

Transfer_lease

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

fencing_token*integer

Fencing token presented by the current holder

Formatint64

Range0 <= value

lease_id*string

Lease ID to transfer

to_holder_id*string

New holder user id

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/leases/string/transfer" \  -H "Content-Type: application/json" \  -d '{    "fencing_token": 0,    "lease_id": "string",    "to_holder_id": "string"  }'

{  "expires_at": "2019-08-24T14:15:22Z",  "fencing_token": 0,  "holder": {    "id": "string",    "kind": "user"  },  "lease_id": "string",  "resource_id": "string"}

POST/api/v1/leases/{resource_id}/validate

Validate_lease

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

fencing_token*integer

Fencing token presented for validation

Formatint64

Range0 <= value

lease_id*string

Lease ID to validate

machine?|

Optional FSM machine name that requires this lease

mode?null|

transition?|

Optional FSM transition name that requires this lease

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/leases/string/validate" \  -H "Content-Type: application/json" \  -d '{    "fencing_token": 0,    "lease_id": "string"  }'

{  "fencing_token": 0,  "lease_id": "string",  "reason": "string",  "resource_id": "string",  "valid": true}

GET/api/v1/leases/{resource_id}/waiting-room

List_waiting_room

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

resource_id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/leases/string/waiting-room"

{  "count": 0,  "resource_id": "string",  "waiters": [    {      "holder_id": "string",      "joined_at": "2019-08-24T14:15:22Z",      "last_seen": "2019-08-24T14:15:22Z",      "mode": "exclusive",      "priority": 0.1    }  ]}

Lease

201application/json

400

403

409

200application/json

404

201application/json

400

404

409

200application/json

400

404

201application/json

400

404

409

200application/json

403

404

409

200application/json

400

404

200application/json

403

404

409

200application/json

400

403

404

409

200application/json

404

200application/json

403

404

409

200application/json

404

200application/json

403

404

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`