Internal API-Builder v1 (1.0.10)

Download OpenAPI specification:Download

Internal api for api builder to allow updating of entities in api-builder db.

portal

insert or updates portal

Accepts a raw database representation of the Portal in the request body. Accepts a raw database representation of any linked default App Auth Strategy in the response body or null if there is none.

path Parameters

portalId

required

string <uuid>

ID of the portal.

Request Body schema: application/json

id required	string <uuid>
name required	string
display_name	string
uri required	string
custom_domain	string or null
is_domain_verified	boolean
logo	string or null
logo_filename	string or null
favicon	string or null
favicon_filename	string or null
is_public	boolean
authentication_enabled	boolean
default_api_visibility	string (Visibility) Enum: "public" "private"
default_page_visibility	string (Visibility) Enum: "public" "private"
auto_approve_developers	boolean
auto_approve_applications	boolean
rbac_enabled	boolean
	object or null
version	string
	object or null
required	object (Labels) <= 50 properties Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".
description	string or null
required	object or null (NullableAuthStrategy)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"display_name": "string",
"uri": "string",
"custom_domain": "string",
"is_domain_verified": true,
"logo": "string",
"logo_filename": "string",
"favicon": "string",
"favicon_filename": "string",
"is_public": true,
"authentication_enabled": true,
"default_api_visibility": "public",
"default_page_visibility": "public",
"auto_approve_developers": true,
"auto_approve_applications": true,
"rbac_enabled": true,
"config": { },
"version": "string",
"customization": { },
"labels": {"env": "test"
},
"description": "string",
"default_application_auth_strategy": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"display_name": "string",
"strategy_type": "string",
"configs": { },
"labels": {"env": "test"
},
"dcr_provider": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"provider_type": "string",
"issuer": "string",
"dcr_config": { },
"labels": {"env": "test"
}
}
}
}

Response samples

400

Content type

application/problem+json

{"status": 0,
"title": "string",
"type": "string",
"instance": "string",
"detail": "string",
"invalid_parameters": [{"field": "name",
"rule": "required",
"source": "body",
"reason": "is a required field"
}
]
}

delete portal

Deletes portal specified in path

path Parameters

portalId

required

string <uuid>

ID of the portal.

query Parameters

force

string

Default: "false"

Enum: "true" "false"

If true, delete also related publications entities

Responses

Response samples

404

Content type

application/problem+json

{"status": 404,
"title": "Not Found",
"instance": "kong:trace:6816496025408232265",
"detail": "Not Found"
}

DCR Providers

Inserts or updates a DCR provider

Accepts a raw database representation of the DCR Provider in the response body

path Parameters

dcrProviderId

required

string <uuid>

Example: ebbac5b0-ac89-45c3-9d2e-c4542c657e79

DCR provider identifier

Request Body schema: application/json

id required	string <uuid>
org_id required	string <uuid>
name required	string (DcrProviderName) [ 1 .. 256 ] characters The name of the DCR provider. This is used to identify the DCR provider in the Konnect UI.
provider_type required	string Enum: "auth0" "azureAd" "curity" "okta" "http" The type of DCR provider. Can be one of the following - auth0, azureAd, curity, okta, http
issuer required	string <url> <= 256 characters
	object or null (LabelsUpdate) <= 50 properties Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Labels are intended to store INTERNAL metadata. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".
required	DcrConfigAuth0InRequest (object) or DcrConfigAzureAdInRequest (object) or DcrConfigCurityInRequest (object) or DcrConfigOktaInRequest (object) or CreateDcrConfigHttpInRequest (object)
created_at required	string <date-time>
updated_at required	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "93f8380e-7798-4566-99e3-2edf2b57d289",
"name": "DCR Auth0 1 - Segment A",
"provider_type": "auth0",
"issuer": "https://my-issuer.auth0.com/api/v2/",
"dcr_config": {"initial_client_id": "abc123",
"initial_client_audience": "https://my-custom-domain.com/api/v2/",
"use_developer_managed_scopes": false
},
"org_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"labels": { },
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z"
}

Response samples

200
400
401
403
404

Content type

application/json

{"id": "93f8380e-7798-4566-99e3-2edf2b57d289",
"name": "DCR Auth0 1 - Segment A",
"provider_type": "auth0",
"issuer": "https://my-issuer.auth0.com/api/v2/",
"dcr_config": {"initial_client_id": "abc123",
"initial_client_audience": "https://my-custom-domain.com/api/v2/",
"use_developer_managed_scopes": false
},
"org_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"labels": { },
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z"
}

Deletes a DCR provider

Deletes a DCR provider.

path Parameters

dcrProviderId

required

string <uuid>

Example: ebbac5b0-ac89-45c3-9d2e-c4542c657e79

DCR provider identifier

Responses

Response samples

401
403
404

Content type

application/problem+json

{"status": 401,
"title": "Unauthorized",
"instance": "kong:trace:8347343766220159418",
"detail": "Unauthorized"
}

App Auth Strategies

Inserts or updates an application auth strategy.

Accepts a raw database representation of the Auth Strategy in the request body. Accepts a raw database representation of the DCR provider (if provided) in the response body.

path Parameters

authStrategyId

required

string <uuid>

Example: ebbac5b0-ac89-45c3-9d2e-c4542c657e79

ID of the auth strategy to use for the application

Request Body schema: application/json

id required	string <uuid>
org_id required	string <uuid>
name required	string [ 1 .. 256 ] characters The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.
display_name required	string <= 256 characters The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.
strategy_type required	string AppAuthStrategyKeyAuth
required	object JSON-B object containing the configuration for the Key Auth strategy
required	object or null (LabelsUpdate) <= 50 properties Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Labels are intended to store INTERNAL metadata. Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".
	object (DcrProvider)
created_at required	string <date-time>
updated_at required	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "93f8380e-7798-4566-99e3-2edf2b57d289",
"name": "strategy",
"display_name": "strategy display name",
"strategy_type": "key_auth",
"org_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"labels": { },
"configs": {"key-auth": {"key_names": ["secret"
]
}
},
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z",
"dcr_provider": {"id": "93f8380e-7798-4566-99e3-2edf2b57d289",
"name": "DCR Auth0 1 - Segment A",
"provider_type": "auth0",
"issuer": "https://my-issuer.auth0.com/api/v2/",
"dcr_config": {"initial_client_id": "abc123",
"initial_client_audience": "https://my-custom-domain.com/api/v2/",
"use_developer_managed_scopes": false
},
"org_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"labels": { },
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z"
}
}

Response samples

200
400
401
403

Content type

application/json

Example

AppAuthStrategyKeyAuth

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
"name": "string",
"display_name": "string",
"strategy_type": "AppAuthStrategyKeyAuth",
"configs": {"key-auth": {"key_names": ["string"
]
}
},
"dcr_provider": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
"name": "string",
"provider_type": "auth0",
"issuer": "string",
"dcr_config": {"initial_client_id": "string",
"initial_client_secret": "string",
"initial_client_audience": "string",
"use_developer_managed_scopes": true
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Deletes an application auth strategy.

Deletes the Auth Strategy.

path Parameters

authStrategyId

required

string <uuid>

Example: ebbac5b0-ac89-45c3-9d2e-c4542c657e79

ID of the auth strategy to use for the application

Responses

Response samples

401
403
404

Content type

application/problem+json

{"status": 401,
"title": "Unauthorized",
"instance": "kong:trace:8347343766220159418",
"detail": "Unauthorized"
}

apis

Retrieves detailed information from each API from a given list of API ids.

Accepts an array of API ids in body Returns a list of APIs with their details

Request Body schema: application/json

api_ids

required

Array of strings <uuid>

Responses

Request samples

Payload

Content type

application/json

{"api_ids": ["93f8380e-7798-4566-99e3-2edf2b57d289",
"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7"
]
}

Response samples

200
400
404

Content type

application/json

{"apis": [{"id": "93f8380e-7798-4566-99e3-2edf2b57d289",
"name": "api1",
"slug": "api1-slug",
"version": "1.0.0"
},
{"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"name": "api2",
"slug": "api2-slug",
"version": "2.0.0"
}
]
}