Skip to main content

Environments API

Usage​

import { epilot } from '@epilot/sdk'

epilot.authorize(() => '<token>')
const { data } = await epilot.environments.listEnvironmentVariables(...)

Tree-shakeable import​

import { getClient, authorize } from '@epilot/sdk/environments'

const environmentsClient = getClient()
authorize(environmentsClient, () => '<token>')
const { data } = await environmentsClient.listEnvironmentVariables(...)

Operations​

environments

Schemas

listEnvironmentVariables​

List environment variables

GET /v1/environments

const { data } = await client.listEnvironmentVariables()
Response
{
  "items": [
    {
      "key": "string",
      "type": "String",
      "description": "string",
      "value": "string",
      "created_at": "1970-01-01T00:00:00.000Z",
      "updated_at": "1970-01-01T00:00:00.000Z"
    }
  ]
}

createEnvironmentVariable​

Create environment variable

POST /v1/environments

const { data } = await client.createEnvironmentVariable(
  null,
  {
    key: 'string',
    type: 'String',
    description: 'string',
    value: 'string'
  },
)
Response
{
  "key": "string",
  "type": "String",
  "description": "string",
  "value": "string",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z"
}

getEnvironmentVariable​

Get environment variable

GET /v1/environments/{key}

const { data } = await client.getEnvironmentVariable({
  key: 'example',
})
Response
{
  "key": "string",
  "type": "String",
  "description": "string",
  "value": "string",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z"
}

updateEnvironmentVariable​

Update environment variable

PUT /v1/environments/{key}

const { data } = await client.updateEnvironmentVariable(
  {
    key: 'example',
  },
  {
    type: 'String',
    value: 'string',
    description: 'string'
  },
)
Response
{
  "key": "string",
  "type": "String",
  "description": "string",
  "value": "string",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z"
}

deleteEnvironmentVariable​

Delete environment variable

DELETE /v1/environments/{key}

const { data } = await client.deleteEnvironmentVariable({
  key: 'example',
})

Schemas​

EnvironmentValueType​

type EnvironmentValueType = "String" | "SecretString"

EnvironmentVariable​

type EnvironmentVariable = {
  key: string
  type: "String" | "SecretString"
  description?: string
  value?: string
  created_at: string // date-time
  updated_at: string // date-time
}

EnvironmentVariableListItem​

type EnvironmentVariableListItem = {
  key: string
  type: "String" | "SecretString"
  description?: string
  value?: string
  created_at: string // date-time
  updated_at: string // date-time
}

EnvironmentVariableList​

type EnvironmentVariableList = {
  items: Array<{
    key: string
    type: "String" | "SecretString"
    description?: string
    value?: string
    created_at: string // date-time
    updated_at: string // date-time
  }>
}

EnvironmentVariableCreateRequest​

type EnvironmentVariableCreateRequest = {
  key: string
  type: "String" | "SecretString"
  description?: string
  value: string
}

EnvironmentVariableUpdateRequest​

type EnvironmentVariableUpdateRequest = {
  type?: "String" | "SecretString"
  value: string
  description?: string
}