Publish or update a public API

Creates a new public API or updates an existing one, and records an immutable version snapshot. The API is org-scoped — no team required.

If publicApiId is provided: update that API.
If omitted: create a new public API using apiSlug + title.
Version conflict: same tag + same spec = idempotent OK; same tag + different spec = 409.

Header Parameters

X-Org-Id*string

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

publicApiId?string

Existing public API id. If missing, creates a new one.

Formatuuid

apiSlug?string

URL-safe slug for the API. Required when publicApiId is not provided. Rules: lowercase letters, digits, hyphens; no spaces; max 63 chars.

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

title?string

Human-readable display name. Required when publicApiId is not provided.

description?string

visibility?string

Default"PUBLISHED"

Value in"DRAFT" | "PUBLISHED" | "UNLISTED"

version*string

Version tag (e.g. v1.0.0).

openapiSpec*string

Full OpenAPI document content (YAML or JSON).

gitSha?string

releaseNotes?string

Response Body

`application/json`

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

{
  "publicApiId": "6cdb160e-37b9-4802-86c1-ee5fed60dba5",
  "apiSlug": "string",
  "orgSlug": "string",
  "version": "string",
  "visibility": "string",
  "created": true,
  "versionCreated": true,
  "publicUrl": "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

402application/json

409application/json

`application/json`

`application/json`

`application/json`

`application/json`