ConfigDirector Environments API
The Environments API from ConfigDirector — 2 operation(s) for environments.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/configdirector-com:configdirector-com-environments-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Configdirector Com Environments API
version: 1.0.0
description: 'Operations tagged Environments across 2 of this provider''s published API definitions: configdirector-com-admin-api-openapi.json, configdirector-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.configdirector.com/v1
security:
- bearerAuth: []
tags:
- name: Environments
paths:
/projects/{projectId}/environments:
get:
operationId: getProjectsByProjectIdEnvironments
tags:
- Environments
summary: List environments
responses:
'200':
description: A list of environments in the project.
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
slug:
type: string
name:
type: string
color:
enum:
- maroon
- red
- purple
- fuchsia
- green
- lime
- olive
- yellow
- navy
- blue
- teal
- aqua
type: string
projectId:
type: string
createdAt:
type: string
updatedAt:
type: string
live:
type: boolean
deletionProtection:
type: boolean
required:
- id
- slug
- name
- color
- projectId
- createdAt
- updatedAt
- live
- deletionProtection
'403':
description: 'The API token is missing the `environments:read` permission, or the request was not authenticated. The body says which: `code` is one of `AUTHORIZATION_HEADER_MISSING`, `AUTHORIZATION_HEADER_INVALID`, `API_TOKEN_NOT_FOUND`, `API_TOKEN_EXPIRED`, `API_TOKEN_OWNER_REMOVED`, `INSUFFICIENT_PERMISSIONS`.'
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
enum:
- AUTHORIZATION_HEADER_MISSING
- AUTHORIZATION_HEADER_INVALID
- API_TOKEN_NOT_FOUND
- API_TOKEN_EXPIRED
- API_TOKEN_OWNER_REMOVED
- INSUFFICIENT_PERMISSIONS
type: string
required:
- error
- code
'404':
description: No project with the given ID exists in the organization.
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
enum:
- PROJECT_NOT_FOUND
type: string
required:
- error
- code
parameters:
- schema:
type: string
in: path
name: projectId
required: true
post:
operationId: postProjectsByProjectIdEnvironments
tags:
- Environments
summary: Create an environment
responses:
'200':
description: The created environment.
content:
application/json:
schema:
type: object
properties:
id:
type: string
slug:
type: string
name:
type: string
color:
enum:
- maroon
- red
- purple
- fuchsia
- green
- lime
- olive
- yellow
- navy
- blue
- teal
- aqua
type: string
projectId:
type: string
createdAt:
type: string
updatedAt:
type: string
live:
type: boolean
deletionProtection:
type: boolean
required:
- id
- slug
- name
- color
- projectId
- createdAt
- updatedAt
- live
- deletionProtection
'400':
description: The request body failed validation.
'403':
description: 'The API token is missing the `environments:create` permission, or the request was not authenticated. The body says which: `code` is one of `AUTHORIZATION_HEADER_MISSING`, `AUTHORIZATION_HEADER_INVALID`, `API_TOKEN_NOT_FOUND`, `API_TOKEN_EXPIRED`, `API_TOKEN_OWNER_REMOVED`, `INSUFFICIENT_PERMISSIONS`.'
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
enum:
- AUTHORIZATION_HEADER_MISSING
- AUTHORIZATION_HEADER_INVALID
- API_TOKEN_NOT_FOUND
- API_TOKEN_EXPIRED
- API_TOKEN_OWNER_REMOVED
- INSUFFICIENT_PERMISSIONS
type: string
required:
- error
- code
'404':
description: No project with the given ID exists in the organization.
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
enum:
- PROJECT_NOT_FOUND
type: string
required:
- error
- code
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 200
slug:
type: string
minLength: 4
maxLength: 150
color:
enum:
- maroon
- red
- purple
- fuchsia
- green
- lime
- olive
- yellow
- navy
- blue
- teal
- aqua
type: string
live:
type: boolean
required:
- name
- slug
- color
- live
parameters:
- schema:
type: string
in: path
name: projectId
required: true
servers:
- url: https://api.configdirector.com/v1
/projects/{projectId}/environments/{environmentId}:
get:
operationId: getProjectsByProjectIdEnvironmentsByEnvironmentId
tags:
- Environments
summary: Get an environment
parameters:
- name: environmentId
in: path
required: true
schema:
type: string
- schema:
type: string
in: path
name: projectId
required: true
responses:
'200':
description: The requested environment.
content:
application/json:
schema:
type: object
properties:
id:
type: string
slug:
type: string
name:
type: string
color:
enum:
- maroon
- red
- purple
- fuchsia
- green
- lime
- olive
- yellow
- navy
- blue
- teal
- aqua
type: string
projectId:
type: string
createdAt:
type: string
updatedAt:
type: string
live:
type: boolean
deletionProtection:
type: boolean
required:
- id
- slug
- name
- color
- projectId
- createdAt
- updatedAt
- live
- deletionProtection
'403':
description: 'The API token is missing the `environments:read` permission, or the request was not authenticated. The body says which: `code` is one of `AUTHORIZATION_HEADER_MISSING`, `AUTHORIZATION_HEADER_INVALID`, `API_TOKEN_NOT_FOUND`, `API_TOKEN_EXPIRED`, `API_TOKEN_OWNER_REMOVED`, `INSUFFICIENT_PERMISSIONS`.'
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
enum:
- AUTHORIZATION_HEADER_MISSING
- AUTHORIZATION_HEADER_INVALID
- API_TOKEN_NOT_FOUND
- API_TOKEN_EXPIRED
- API_TOKEN_OWNER_REMOVED
- INSUFFICIENT_PERMISSIONS
type: string
required:
- error
- code
'404':
description: No environment with the given ID exists in the project, or no project with the given ID exists in the organization. `code` says which.
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
enum:
- ENVIRONMENT_NOT_FOUND
- PROJECT_NOT_FOUND
type: string
required:
- error
- code
put:
operationId: putProjectsByProjectIdEnvironmentsByEnvironmentId
tags:
- Environments
summary: Update an environment
description: Changes the environment's name, slug, color or live flag. The environment's Deletion protection setting, `deletionProtection`, is read-only here and changes in the dashboard.
parameters:
- name: environmentId
in: path
required: true
schema:
type: string
- schema:
type: string
in: path
name: projectId
required: true
responses:
'200':
description: The updated environment.
content:
application/json:
schema:
type: object
properties:
id:
type: string
slug:
type: string
name:
type: string
color:
enum:
- maroon
- red
- purple
- fuchsia
- green
- lime
- olive
- yellow
- navy
- blue
- teal
- aqua
type: string
projectId:
type: string
createdAt:
type: string
updatedAt:
type: string
live:
type: boolean
deletionProtection:
type: boolean
required:
- id
- slug
- name
- color
- projectId
- createdAt
- updatedAt
- live
- deletionProtection
'400':
description: The request body failed validation.
'403':
description: 'The API token is missing the `environments:update` permission, or the request was not authenticated. The body says which: `code` is one of `AUTHORIZATION_HEADER_MISSING`, `AUTHORIZATION_HEADER_INVALID`, `API_TOKEN_NOT_FOUND`, `API_TOKEN_EXPIRED`, `API_TOKEN_OWNER_REMOVED`, `INSUFFICIENT_PERMISSIONS`.'
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
enum:
- AUTHORIZATION_HEADER_MISSING
- AUTHORIZATION_HEADER_INVALID
- API_TOKEN_NOT_FOUND
- API_TOKEN_EXPIRED
- API_TOKEN_OWNER_REMOVED
- INSUFFICIENT_PERMISSIONS
type: string
required:
- error
- code
'404':
description: No environment with the given ID exists in the project, or no project with the given ID exists in the organization. `code` says which.
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
enum:
- ENVIRONMENT_NOT_FOUND
- PROJECT_NOT_FOUND
type: string
required:
- error
- code
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id:
type: string
minLength: 1
name:
type: string
minLength: 1
maxLength: 200
slug:
type: string
minLength: 4
maxLength: 150
color:
enum:
- maroon
- red
- purple
- fuchsia
- green
- lime
- olive
- yellow
- navy
- blue
- teal
- aqua
type: string
live:
type: boolean
required:
- id
- name
- slug
- color
- live
delete:
operationId: deleteProjectsByProjectIdEnvironmentsByEnvironmentId
tags:
- Environments
summary: Delete an environment
parameters:
- name: environmentId
in: path
required: true
schema:
type: string
- schema:
type: string
in: path
name: projectId
required: true
responses:
'204':
description: The environment was deleted.
'400':
description: 'The environment cannot be deleted: deletion protection is on for it, or it is the project''s last environment. `errors[0].message` says which.'
'403':
description: 'The API token is missing the `environments:delete` permission, or the request was not authenticated. The body says which: `code` is one of `AUTHORIZATION_HEADER_MISSING`, `AUTHORIZATION_HEADER_INVALID`, `API_TOKEN_NOT_FOUND`, `API_TOKEN_EXPIRED`, `API_TOKEN_OWNER_REMOVED`, `INSUFFICIENT_PERMISSIONS`.'
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
enum:
- AUTHORIZATION_HEADER_MISSING
- AUTHORIZATION_HEADER_INVALID
- API_TOKEN_NOT_FOUND
- API_TOKEN_EXPIRED
- API_TOKEN_OWNER_REMOVED
- INSUFFICIENT_PERMISSIONS
type: string
required:
- error
- code
'404':
description: No environment with the given ID exists in the project, or no project with the given ID exists in the organization. `code` says which.
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
enum:
- ENVIRONMENT_NOT_FOUND
- PROJECT_NOT_FOUND
type: string
required:
- error
- code
servers:
- url: https://api.configdirector.com/v1
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
x-refined-from:
- configdirector-com-admin-api-openapi.json
- configdirector-com-openapi.yml