ConfigDirector Projects API

The Projects API from ConfigDirector — 2 operation(s) for projects.

GitHub OpenAPI

Operations 5

GET /projects List projects #
POST /projects Create a project #
GET /projects/{projectId} Get a project #
PUT /projects/{projectId} Update a project #
DELETE /projects/{projectId} Delete a project #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/configdirector-com:configdirector-com-projects-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

configdirector-com-projects-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Configdirector Com Projects API
  version: 1.0.0
  description: 'Operations tagged Projects 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: Projects
paths:
  /projects:
    get:
      operationId: getProjects
      tags:
      - Projects
      summary: List projects
      responses:
        '200':
          description: A list of projects in the organization. Never includes `environments`. Each project carries its Code snippets setting, `storeCodeSnippets`, and its Deletion protection setting, `deletionProtection`.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    name:
                      type: string
                    slug:
                      type: string
                    organizationId:
                      type: string
                    storeCodeSnippets:
                      type: boolean
                    deletionProtection:
                      type: boolean
                    createdAt:
                      type: string
                    updatedAt:
                      type: string
                  required:
                  - id
                  - name
                  - slug
                  - organizationId
                  - storeCodeSnippets
                  - deletionProtection
                  - createdAt
                  - updatedAt
        '403':
          description: 'The API token is missing the `projects: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
    post:
      operationId: postProjects
      tags:
      - Projects
      summary: Create a project
      responses:
        '200':
          description: The created project.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  slug:
                    type: string
                  organizationId:
                    type: string
                  storeCodeSnippets:
                    type: boolean
                  deletionProtection:
                    type: boolean
                  createdAt:
                    type: string
                  updatedAt:
                    type: string
                  environments:
                    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
                required:
                - id
                - name
                - slug
                - organizationId
                - storeCodeSnippets
                - deletionProtection
                - createdAt
                - updatedAt
        '400':
          description: The request body failed validation.
        '403':
          description: 'The API token is missing the `projects: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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                slug:
                  type: string
                  minLength: 1
                  pattern: ^[\da-z]+(?:[-_][\da-z]+)*$
                  maxLength: 255
              required:
              - name
              - slug
    servers:
    - url: https://api.configdirector.com/v1
  /projects/{projectId}:
    get:
      operationId: getProjectsByProjectId
      tags:
      - Projects
      summary: Get a project
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The requested project.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  slug:
                    type: string
                  organizationId:
                    type: string
                  storeCodeSnippets:
                    type: boolean
                  deletionProtection:
                    type: boolean
                  createdAt:
                    type: string
                  updatedAt:
                    type: string
                  environments:
                    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
                required:
                - id
                - name
                - slug
                - organizationId
                - storeCodeSnippets
                - deletionProtection
                - createdAt
                - updatedAt
        '403':
          description: 'The API token is missing the `projects: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
    put:
      operationId: putProjectsByProjectId
      tags:
      - Projects
      summary: Update a project
      description: Renames the project or changes its slug. The project's Code snippets setting, `storeCodeSnippets`, is read-only here and changes in the dashboard. The project's Deletion protection setting, `deletionProtection`, is read-only here and changes in the dashboard.
      responses:
        '204':
          description: The project was updated.
        '400':
          description: The request body failed validation.
        '403':
          description: 'The API token is missing the `projects: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 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:
                id:
                  type: string
                  minLength: 1
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                slug:
                  type: string
                  minLength: 1
                  pattern: ^[\da-z]+(?:[-_][\da-z]+)*$
                  maxLength: 255
              required:
              - id
              - name
              - slug
      parameters:
      - schema:
          type: string
        in: path
        name: projectId
        required: true
    delete:
      operationId: deleteProjectsByProjectId
      tags:
      - Projects
      summary: Delete a project
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: The project was deleted.
        '400':
          description: 'The project cannot be deleted: deletion protection is on for it or for one of its environments, or it is the organization''s last project. `errors[0].message` says which.'
        '403':
          description: 'The API token is missing the `projects: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 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
    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