v14

OpenAPI 3.0.32026-08-04377889.4 MB

environment

Retrieve the decrypted value of a Shared Environment Variable by id.

get/v1/env/{id}

Path parameters

idstring required

The unique ID for the Shared Environment Variable to get the decrypted value.

Query parameters

teamIdstring

Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring

Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

createdstring date-time

The date when the Shared Env Var was created.

keystring

The name of the Shared Env Var.

ownerIdstring nullable

The unique identifier of the owner (team) the Shared Env Var was created for.

idstring

The unique identifier of the Shared Env Var.

createdBystring nullable

The unique identifier of the user who created the Shared Env Var.

deletedBystring nullable

The unique identifier of the user who deleted the Shared Env Var.

updatedBystring nullable

The unique identifier of the user who last updated the Shared Env Var.

createdAtnumber

Timestamp for when the Shared Env Var was created.

deletedAtnumber

Timestamp for when the Shared Env Var was (soft) deleted.

updatedAtnumber

Timestamp for when the Shared Env Var was last updated.

valuestring

The value of the Shared Env Var.

projectIdstring[]

The unique identifiers of the projects which the Shared Env Var is linked to.

type'encrypted' | 'plain' | 'sensitive' | 'system'

The type of this cosmos doc instance, if blank, assume secret.

targetstring[]

environments this env variable targets

applyToAllCustomEnvironmentsfalse | true

whether or not this env varible applies to custom environments

customEnvironmentIdsstring[]

The custom environment IDs that this Shared Env Var is scoped to.

decryptedfalse | true

whether or not this env variable is decrypted

commentstring

A user provided comment that describes what this Shared Env Var is for.

lastEditedByDisplayNamestring

The last editor full name or username.

Example response

{
  "created": "2021-02-10T13:11:49.180Z",
  "key": "my-api-key",
  "ownerId": "team_LLHUOMOoDlqOp8wPE4kFo9pE",
  "id": "env_XCG7t7AIHuO2SBA8667zNUiM",
  "createdBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
  "deletedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
  "updatedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
  "createdAt": 1609492210000,
  "deletedAt": 1609492210000,
  "updatedAt": 1609492210000,
  "projectId": [
    "prj_2WjyKQmM8ZnGcJsPWMrHRHrE",
    "prj_2WjyKQmM8ZnGcJsPWMrasEFg"
  ],
  "type": "encrypted",
  "target": [
    "production"
  ]
}