Publish OpenAPI spec from CLI

Publishes a design-time API spec for CLI workflows.

If apiId is provided: update that API metadata/spec and publish version.
If apiId is omitted: create a new API using name + team and publish version.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

apiId?string

Existing API id. Deprecated in favour of slug-based upsert (name + org). Still accepted for backward compatibility.

Formatuuid

name?string

API name (kebab-case). If omitted, derived from the basename of specFilePath (e.g. api/payment-api.yaml → payment-api). Required if specFilePath is also omitted.

Match^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$

team?string

Team UUID OR team slug. If omitted, the API is placed in the org's "Unassigned APIs" team.

Match^([0-9a-fA-F-]{36}|[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)$

version?string

Semver version to publish (MAJOR.MINOR.PATCH). If omitted, the version is extracted from info.version in the spec. If semver flag is set, this field is ignored.

Match^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)([-+].+)?$

openapiSpec*string

OpenAPI document content (YAML or JSON).

gitSha?string

Git commit SHA of the spec file. Used as the primary change detector. If unchanged since last publish, the request is treated as a no-op.

githubRepo?string

githubBranch?string

specFilePath?string

Path to the spec file in the repository. Used to derive API name if name is not provided.

semver?boolean

If true, the backend runs oasdiff to classify the change and auto-computes the next semver tag (PATCH / NON_BREAKING / BREAKING). The computed version is stored in the version snapshot; the developer's original file is never modified.

Defaultfalse

Response Body

`application/json`

curl -X POST "https://loading/api-management/cli/v1/publish" \  -H "X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "openapiSpec": "string"  }'

{
  "apiId": "2500ac85-f71b-4d01-b32c-62f3af3fe2c5",
  "specRecordId": "f0de8374-0665-454e-81ee-9d4898be7f8b",
  "version": "string",
  "created": true,
  "versionCreated": true,
  "noChanges": true,
  "versionUnchanged": true,
  "versionUnchangedHint": "string",
  "apiName": "string",
  "teamName": "string",
  "orgSlug": "string",
  "registryUrl": "string"
}

{
  "status": 0,
  "title": "string",
  "detail": "string"
}

{
  "status": 0,
  "title": "string",
  "detail": "string"
}

{
  "status": 0,
  "title": "string",
  "detail": "string"
}

{
  "status": 0,
  "title": "string",
  "detail": "string"
}

{
  "status": 0,
  "title": "string",
  "detail": "string"
}

Header Parameters

Request Body

Response Body

200application/json

400application/json

403application/json

404application/json

409application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`