Skip to main content
POST
Attach an API spec (OpenAPI, Markdown or a link) to a vendor.

Authorizations

Authorization
string
header
required

A platform API key, created in the Console under Developers. Pass as Authorization: Bearer <key>. It acts as itself, under its role grants narrowed by its scopes.

Headers

Idempotency-Key
string

1–255 printable ASCII characters (0x21–0x7E, no spaces), scoped to the calling credential. A repeat with the same key and request never runs the write again, a 5xx included: once the operation's permissions pass again it answers the identical status and body of the first response (Idempotent-Replayed: true, also sent as Idempotency-Replayed: true), unless the operation's own replay policy withholds it; a first response that was not stored (over 32 KiB, or carrying a one-time secret) answers its first status with only data.id (Idempotency-Replay-Disclosure: id-only) when it named one; otherwise 409 idempotency_result_unavailable; a repeat while the first is still running is 409 idempotency_key_in_flight, and the same key with a different request is 422 idempotency_key_reuse. Honoured for External App JWTs and platform and Personal keys; an External App's static companion key is not protected.

Required string length: 1 - 255

Body

application/json
vendorKey
string
required
kind
required
Allowed value: "openapi"
title
string
required
connectionName
string
sourceUrl
string
fileId
string
version
string
notes
string

Response

Attach an API spec (OpenAPI, Markdown or a link) to a vendor.

data
string
required
meta
object
required