AIaikido

Update OpenAPI spec

Updates the OpenAPI spec of a domain with a specified id

put/domains/{domain_id}/update/openapi-spec

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/domains/{domain_id}/update/openapi-spec
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: domains:write

Path parameters

domain_idinteger required

The ID of the domain to update the OpenAPI spec for

Request body

openapi_specstring required

The stringified OpenAPI Spec content. Format must be JSON or YAML.

Example request

{
  "openapi_spec": "{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Aikido Security DEMO\",\"version\":\"1.0.0\",}},\"paths\":{\"/test\":{\"get\":{}}}}"
}

Response

The OpenAPI Spec has been successfully updated

successinteger

An integer 1 indicating success

Example response

{
  "success": "1"
}

Changes

No recorded changes to this operation across all 1 revision of this API.