Internal Portal (1.0.2)

Download OpenAPI specification:Download

URL: https://konghq.com

Internal api for konnect to allow retrieving of entities in konnect db.

portal

retrieve a portal

Returns a raw database representation of the portal.

path Parameters

portalId

required

string <uuid>

ID of the portal.

Responses

Response samples

200
404

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": {"theme": {"name": "string",
"mode": "light",
"colors": {"primary": "#000000"
}
},
"layout": "string",
"css": "string",
"js": {"custom": "string",
"scripts": ["string"
]
},
"menu": {"main": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
],
"footer_sections": [{"title": "string",
"items": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
}
],
"footer_bottom": [{"path": "/about/company",
"title": "My Page",
"visibility": "public",
"external": true
}
]
},
"spec_renderer": {"try_it_ui": true,
"try_it_insomnia": true,
"infinite_scroll": true,
"show_schemas": true
},
"robots": "string"
},
"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"
}
}
}
}

App Auth Strategies

retrieve an auth strategy

Returns a raw database representation of 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

200
404

Content type

application/json

{"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"
}
}
}

api-products

retrieves a product version id by control plane and gateway service

returns product version id or 404 if not found

path Parameters

controlPlaneId required	string <uuid> Example: 9524ec7d-36d9-465d-a8c5-83a3c9390458 The UUID of your control plane. This variable is available in the Konnect manager.
gatewayServiceId required	string <uuid> ID of the gateway service.

Responses

Response samples

200
404

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Portal Developers

Update Developer

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Internal endpoint to update the status of a developer.

path Parameters

portalId required	string <uuid> ID of the portal.
developerId required	string <uuid> Example: d32d905a-ed33-46a3-a093-d8f536af9a8a ID of the developer.

Request Body schema: application/json

Update a developer.

status

string (DeveloperStatus)

Enum: "approved" "pending" "revoked" "rejected"

The status of a developer in a portal. Approved developers can log in, create applications, and view and register for products they have access to. Pending, revoked, and rejected developers cannot login or view any non-public portal information, or create or modify applications or registrations.

Responses

Request samples

Payload

Content type

application/json

Example

Approved

{"status": "approved"
}

Response samples

400
401
403
404

Content type

application/problem+json

{"status": 400,
"title": "Invalid Request",
"instance": "kong:trace:1433447772874964729",
"detail": "Invalid Parameters",
"invalid_parameters": [{"field": "status",
"rule": "enum",
"choices": ["approved",
"pending",
"rejected",
"revoked"
],
"reason": "status must be one of the following values: approved, pending, rejected, revoked"
}
]
}

Delete Developer

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Internal endpoint to delete a developer on a portal.

path Parameters

portalId required	string <uuid> ID of the portal.
developerId required	string <uuid> Example: d32d905a-ed33-46a3-a093-d8f536af9a8a ID of the developer.

Responses

Response samples

401
403
404

Content type

application/problem+json

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