Skip to main content
GET
/
v1
/
apis
/
{api_id}
/
exports
/
openapi
Export API as OpenAPI
curl --request GET \
  --url https://api.peel.sh/v1/apis/{api_id}/exports/openapi \
  --header 'X-API-Key: <api-key>'
{
  "openapi": "<string>",
  "info": {
    "title": "<string>",
    "version": "<string>",
    "description": "<string>"
  },
  "servers": [
    {
      "url": "<string>"
    }
  ],
  "paths": {},
  "x-auth": {},
  "x-api-identity": {
    "api_id": "<string>",
    "binding_id": "<string>",
    "version_id": "<string>"
  },
  "components": {},
  "security": [
    {}
  ],
  "x-binding-id": "<string>",
  "x-version-id": "<string>"
}

Authorizations

X-API-Key
string
header
required

Path Parameters

api_id
string<uuid>
required

Response

Generated OpenAPI export.

openapi
string
required
Allowed value: "3.1.0"
info
object
required
servers
object[]
required
paths
object
required
x-auth
object
required
x-api-identity
object
required
components
object
security
object[]
x-binding-id
string
x-version-id
string