Codesphere

Codesphere Public API

REST API to manage Codesphere workspaces, CI/deploy pipelines, landscapes, managed services, domains, teams, organizations, secret vaults, SSH keys, and usage. OpenAPI 3.0.0, 80 operations, bearer (Personal Access Token) auth.

GitHub OpenAPI

Documentation

📖
APIReference
https://cloud.codesphere.com/api/swagger-ui

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/codesphere/refs/heads/main/openapi/codesphere-openapi-original.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/codesphere/refs/heads/main/overlays/codesphere-openapi-overlay.yaml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/codesphere/refs/heads/main/apis.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/codesphere/refs/heads/main/arazzo/_index.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/codesphere/refs/heads/main/arazzo/codesphere-deploy-workspace.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/codesphere/refs/heads/main/arazzo/codesphere-provision-managed-service.yml

OpenAPI Specification

codesphere-openapi-original.json Raw ↑ 
{
  "openapi": "3.0.0",
  "info": {
    "title": "Codesphere Public API",
    "version": "0.1.0"
  },
  "paths": {
    "/clusters/organizations": {
      "get": {
        "summary": "listAllOrganizations",
        "tags": [
          "clusters"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Success.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "UUID",
                        "format": "uuid",
                        "example": "8316ee2f-87f8-424e-b925-7382dc50d662"
                      },
                      "name": {
                        "type": "string"
                      },
                      "createdAt": {
                        "type": "string",
                        "format": "date-time"
                      }
                    },
                    "required": [
                      "id",
                      "name",
                      "createdAt"
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "description": "Authorization information is missing or invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "enum": [
                        401
                      ]
                    },
                    "title": {
                      "type": "string"
                    },
                    "detail": {
                      "type": "string"
                    },
                    "traceId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "title",
                    "traceId"
                  ]
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "operationId": "clusters-listAllOrganizations"
      },
      "post": {
        "summary": "createOrganization",
        "tags": [
          "clusters"
        ],
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "adminEmail": {
                    "type": "string",
                    "description": "Valid email address",
                    "format": "email",
                    "example": "test@example.com"
                  }
                },
                "required": [
                  "name",
                  "adminEmail"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "UUID",
                      "format": "uuid",
                      "example": "8316ee2f-87f8-424e-b925-7382dc50d662"
                    },
                    "name": {
                      "type": "string"
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "createdAt"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Admin account is deactivated, path or request body variable does not match schema.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "enum": [
                        400
                      ]
                    },
                    "title": {
                      "type": "string"
                    },
                    "detail": {
                      "type": "string"
                    },
                    "traceId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "title",
                    "traceId"
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Authorization information is missing or invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "enum": [
                        401
                      ]
                    },
                    "title": {
                      "type": "string"
                    },
                    "detail": {
                      "type": "string"
                    },
                    "traceId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "title",
                    "traceId"
                  ]
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "operationId": "clusters-createOrganization"
      }
    },
    "/clusters/admins": {
      "post": {
        "summary": "addClusterAdmin",
        "tags": [
          "clusters"
        ],
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string",
                    "description": "Valid email address",
                    "format": "email",
                    "example": "test@example.com"
                  }
                },
                "required": [
                  "email"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success."
          },
          "400": {
            "description": "Account is deactivated, path or request body variable does not match schema.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "enum": [
                        400
                      ]
                    },
                    "title": {
                      "type": "string"
                    },
                    "detail": {
                      "type": "string"
                    },
                    "traceId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "title",
                    "traceId"
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Authorization information is missing or invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "enum": [
                        401
                      ]
                    },
                    "title": {
                      "type": "string"
                    },
                    "detail": {
                      "type": "string"
                    },
                    "traceId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "title",
                    "traceId"
                  ]
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "operationId": "clusters-addClusterAdmin"
      }
    },
    "/domains/team/{teamId}/domain/{domainName}": {
      "get": {
        "summary": "getDomain",
        "tags": [
          "domains"
        ],
        "parameters": [
          {
            "name": "teamId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 0
            }
          },
          {
            "name": "domainName",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "A valid FQDN.",
              "example": "foo.example.com"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "teamId": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "dataCenterId": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "workspaces": {
                      "type": "object",
                      "additionalProperties": {
                        "type": "array",
                        "items": {
                          "type": "integer",
                          "minimum": 0
                        }
                      }
                    },
                    "name": {
                      "type": "string"
                    },
                    "certificateRequestStatus": {
                      "type": "object",
                      "properties": {
                        "issued": {
                          "type": "boolean"
                        },
                        "reason": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "required": [
                        "issued",
                        "reason"
                      ]
                    },
                    "dnsEntries": {
                      "type": "object",
                      "properties": {
                        "a": {
                          "type": "string"
                        },
                        "cname": {
                          "type": "string"
                        },
                        "txt": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "a",
                        "cname",
                        "txt"
                      ]
                    },
                    "domainVerificationStatus": {
                      "type": "object",
                      "properties": {
                        "verified": {
                          "type": "boolean"
                        },
                        "reason": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "required": [
                        "verified",
                        "reason"
                      ]
                    },
                    "customConfigRevision": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "customConfig": {
                      "type": "object",
                      "properties": {
                        "maxBodySizeMb": {
                          "type": "number"
                        },
                        "maxConnectionTimeoutS": {
                          "type": "number"
                        },
                        "useRegex": {
                          "type": "boolean"
                        }
                      }
                    },
                    "restricted": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "teamId",
                    "dataCenterId",
                    "workspaces",
                    "name",
                    "certificateRequestStatus",
                    "dnsEntries",
                    "domainVerificationStatus"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Path or request body variable does not match schema.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "enum": [
                        400
                      ]
                    },
                    "title": {
                      "type": "string"
                    },
                    "detail": {
                      "type": "string"
                    },
                    "traceId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "title",
                    "traceId"
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Authorization information is missing or invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "enum": [
                        401
                      ]
                    },
                    "title": {
                      "type": "string"
                    },
                    "detail": {
                      "type": "string"
                    },
                    "traceId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "title",
                    "traceId"
                  ]
                }
              }
            }
          },
          "404": {
            "description": "Domain not found.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "enum": [
                        404
                      ]
                    },
                    "title": {
                      "type": "string"
                    },
                    "detail": {
                      "type": "string"
                    },
                    "traceId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "title",
                    "traceId"
                  ]
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "operationId": "domains-getDomain"
      },
      "post": {
        "summary": "createDomain",
        "tags": [
          "domains"
        ],
        "parameters": [
          {
            "name": "teamId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 0
            }
          },
          {
            "name": "domainName",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "A valid FQDN.",
              "example": "foo.example.com"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "teamId": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "dataCenterId": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "workspaces": {
                      "type": "object",
                      "additionalProperties": {
                        "type": "array",
                        "items": {
                          "type": "integer",
                          "minimum": 0
                        }
                      }
                    },
                    "name": {
                      "type": "string"
                    },
                    "certificateRequestStatus": {
                      "type": "object",
                      "properties": {
                        "issued": {
                          "type": "boolean"
                        },
                        "reason": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "required": [
                        "issued",
                        "reason"
                      ]
                    },
                    "dnsEntries": {
                      "type": "object",
                      "properties": {
                        "a": {
                          "type": "string"
                        },
                        "cname": {
                          "type": "string"
                        },
                        "txt": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "a",
                        "cname",
                        "txt"
                      ]
                    },
                    "domainVerificationStatus": {
                      "type": "object",
                      "properties": {
                        "verified": {
                          "type": "boolean"
                        },
                        "reason": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "required": [
                        "verified",
                        "reason"
                      ]
                    },
                    "customConfigRevision": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "customConfig": {
                      "type": "object",
                      "properties": {
                        "maxBodySizeMb": {
                          "type": "number"
                        },
                        "maxConnectionTimeoutS": {
                          "type": "number"
                        },
                        "useRegex": {
                          "type": "boolean"
                        }
                      }
                    },
                    "restricted": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "teamId",
                    "dataCenterId",
                    "workspaces",
                    "name",
                    "certificateRequestStatus",
                    "dnsEntries",
                    "domainVerificationStatus"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Path or request body variable does not match schema.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "enum": [
                        400
                      ]
                    },
                    "title": {
                      "type": "string"
                    },
                    "detail": {
                      "type": "string"
                    },
                    "traceId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "title",
                    "traceId"
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Authorization information is missing or invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "enum": [
                        401
                      ]
                    },
                    "title": {
                      "type": "string"
                    },
                    "detail": {
                      "type": "string"
                    },
                    "traceId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "title",
                    "traceId"
                  ]
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "operationId": "domains-createDomain"
      },
      "patch": {
        "summary": "updateDomain",
        "tags": [
          "domains"
        ],
        "parameters": [
          {
            "name": "teamId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 0
            }
          },
          {
            "name": "domainName",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "A valid FQDN.",
              "example": "foo.example.com"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "maxBodySizeMb": {
                    "type": "number"
                  },
                  "maxConnectionTimeoutS": {
                    "type": "number"
                  },
                  "useRegex": {
                    "type": "boolean"
                  },
                  "restricted": {
                    "type": "boolean"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "teamId": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "dataCenterId": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "workspaces": {
                      "type": "object",
                      "additionalProperties": {
                        "type": "array",
                        "items": {
                          "type": "integer",
                          "minimum": 0
                        }
                      }
                    },
                    "name": {
                      "type": "string"
                    },
                    "certificateRequestStatus": {
                      "type": "object",
                      "properties": {
                        "issued": {
                          "type": "boolean"
                        },
                        "reason": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "required": [
                        "issued",
                        "reason"
                      ]
                    },
                    "dnsEntries": {
                      "type": "object",
                      "properties": {
                        "a": {
                          "type": "string"
                        },
                        "cname": {
                          "type": "string"
                        },
                        "txt": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "a",
                        "cname",
                        "txt"
                      ]
                    },
                    "domainVerificationStatus": {
                      "type": "object",
                      "properties": {
                        "verified": {
                          "type": "boolean"
                        },
                        "reason": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "required": [
                        "verified",
                        "reason"
                      ]
                    },
                    "customConfigRevision": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "customConfig": {
                      "type": "object",
                      "properties": {
                        "maxBodySizeMb": {
                          "type": "number"
                        },
                        "maxConnectionTimeoutS": {
                          "type": "number"
                        },
                        "useRegex": {
                          "type": "boolean"
                        }
                      }
                    },
                    "restricted": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "teamId",
                    "dataCenterId",
                    "workspaces",
                    "name",
                    "certificateRequestStatus",
                    "dnsEntries",
                    "domainVerificationStatus"
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Path or request body variable does not match schema.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "enum": [
                        400
                      ]
                    },
                    "title": {
                      "type": "string"
                    },
                    "detail": {
                      "type": "string"
                    },
                    "traceId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "title",
                    "traceId"
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Authorization information is missing or invalid.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "enum": [
                        401
                      ]
                    },
                    "title": {
                      "type": "string"
                    },
                    "detail": {
                      "type": "string"
                    },
                    "traceId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "title",
                    "traceId"
                  ]
                }
              }
            }
          },
          "404": {
            "description": "Domain not found.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "enum": [
                        404
                      ]
                    },
                    "title": {
                      "type": "string"
                    },
                    "detail": {
                      "type": "string"
                    },
                    "traceId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "title",
                    "traceId"
                  ]
                }
              }
            }
          },
          "409": {
            "description": "Another request is in progress.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "enum": [
                        409
                      ]
                    },
                    "title": {
                      "type": "string"
                    },
                    "detail": {
                      "type": "string"
                    },
                    "traceId": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "status",
                    "title",
                    "traceId"
                  ]
                }
              }
            }
          }
        },
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "operationId": "domains-updateDomain"
      },
      "delete": {
        "summary": "deleteDomain",
        "tags": [
          "domains"
        ],
        "parameters": [
          {
            "name": "teamId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "minimum": 0
            }
          },
          {
            "name": "domainName",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "description": "A valid FQDN.",
              "example": "foo.example.com"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success."
          },
    

# --- truncated at 32 KB (460 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codesphere/refs/heads/main/openapi/codesphere-openapi-original.json