SparQDocs
GuidesAPI referencesparqhq.ai
API referenceTenancy

Update Environment

PATCH
/v1/admin/environments/{environment_id}

Not available yet. This operation is part of the published contract and answers 501 not_implemented until it is built. The request and response shapes below are final for this contract version.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Bearer credential. API keys look like sqk_<geo>_<key_id>_<secret>: treat them as opaque and never put one in a browser. Older keys without the geo part stay valid until rotated. Find a geo's endpoints through GET /.well-known/sparq-discovery before sending a key.

Path Parameters

environment_id*Environment Id
Formatuuid

Header Parameters

Sparq-Workspace?string

For a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.

Formatuuid
If-Match?string

The ETag you last read. A different current version is precondition_failed (412). Optional in 0.5.0.

Request Body

application/json
  1. body

PATCH /v1/admin/environments/{environment_id}.

order?|null
protected?boolean|null

Response Body

Successful Response

application/json
  1. response

A stage of a project: dev, qa, preprod, prod.

environment_id*Environment Id
Formatuuid
project_id*Project Id
Formatuuid
name*Name

Environment name, for example 'dev', 'qa', 'preprod' or 'prod'.

Match^[a-z][a-z0-9-]{0,30}$
order*Order

Promotion order: lower comes first.

Range0 <= value
protected*Protected
live_release_id*|

The Release new runs use, if any.

created_at*Created At
Formatdate-time
tier?|

development, test, staging or production (ADR-0011); an open set.

Example Request
curl -X PATCH 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/environments/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",  "name": "string",  "order": 0,  "protected": true,  "live_release_id": "802216bd-321e-4edf-8bab-dc5a1254e43d",  "created_at": "2019-08-24T14:15:22Z",  "tier": "string"}

Update Audience Tenant PATCH

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version.

Update Project PATCH

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version.