Deployments

How your Bash is set up, in versions: apply a whole vestra.yaml, promote, roll back, and the interview that drafts the file.

Send Authorization: Bearer vk_test_... on every call. Every route of Deployments.

PATCH/v1/deployments/{deployment_id}Rename, describe or archive it.

Your API key, scope setup or all. On the card: deploy. Over HTTP it is made from the contract: fill in each {…} and every value.

Request4 fields

Path

deployment_idstringrequiredThe deployment's id (dep_...). The /v1/deployments routes also take its name.

Type: string

Body

namestringA new name, 1 to 120 characters.

Limits: 1 to 120 characters.

descriptionstringA new description, up to 2,000 characters.

Limits: At most 2000 characters.

status"active" | "archived"archived puts it away: no new conversation or version reaches it. active brings it back.

Type: "active" | "archived"

Answers 20011 fields

idstringThe deployment's id.

Example: dep_8f2k

object"deployment"Always deployment.

Type: "deployment"

namestringIts name, as people read it.

Type: string

slugstringIts name in URLs and refs: send it where a route takes {deployment_id}.

Example: trip-rescue

descriptionstringWhat it is for; empty when none was given.

Type: string

base"bash"What it is built on: always bash.

Type: "bash"

status"active" | "archived"active, or archived (put away: no new conversation or version reaches it).

Type: "active" | "archived"

draft_versionintegerThe version test keys run. A new save moves it there; a promote with a test key moves it to the version named, older ones included.

Type: integer

live_versioninteger | nullThe version live keys run; null until one is promoted.

Type: integer | null

created_atstringWhen it was made, as an ISO 8601 date and time in UTC.

Type: string

updated_atstringWhen it last changed, as an ISO 8601 date and time in UTC.

Type: string

HTTP

No sample in your language for this route, so here it is over HTTP.

curl -X PATCH "$VESTRA_BASE_URL/v1/deployments/{deployment_id}" \  -H "Authorization: Bearer $VESTRA_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'