AIaikido

Create domain

Create a new domain

post/domains

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/domains
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: domains:write

Request body

domainstring required

The domain name.

kind'front_end' | 'rest_api' | 'graphql_api' | 'attack_surface' required

The kind of domain you want to add.

zen_service_idinteger

The Zen service ID which shoud generate the OpenAPI spec. This, 'openapi_spec_base64' or 'openapi_spec_url' must be provided when using kind 'rest_api' or 'graphql_api'

openapi_spec_base64string

The base64 encoded JSON or YAML OpenAPI spec you want to use for this domain. This, 'zen_service_id' or 'openapi_spec_url' must be provided when using kind 'rest_api' or 'graphql_api'

openapi_spec_urlstring

The URL to the JSON or YAML OpenAPI spec you want to use for this domain. This, 'zen_service_id' or 'openapi_spec_base64' must be provided when using kind 'rest_api' or 'graphql_api'

Example request

{
  "domain": "https://www.example.com",
  "kind": "front_end"
}

Response

The domain has been successfully created

idinteger

The ID of the newly created domain in Aikido.

Example response

{
  "id": 1
}

Changes

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