Service Catalog API

Management of service catalog which registers services and APIs.

Retrieve a list of available APIs

get

This endpoint returns a paginated list of configured APIs that clients can consume. It provides information on the services available through the unified gateway, enabling effective management of API usage and access.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: api.catalogs.list is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Query parameters

limitinteger · int32OptionalDefault: 1024

startinteger · int32OptionalDefault: 0

Responses

200

The API list

application/json

401

Unauthorized

*/*

get

/console/gateway

HTTPcURLJavaScriptPython

GET /console/gateway HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "code": "text",
    "summary": "text",
    "org_id": "text",
    "project_id": "text",
    "icon": "text",
    "creation_date": "2025-12-16T22:12:01.738Z",
    "external_id": "text",
    "url": "text",
    "documentation_url": "text",
    "terms_url": "text",
    "health_check_url": "text",
    "open_api_url": "text",
    "mock_api_url": "text",
    "ping_route": "text",
    "price_url": "text",
    "support_url": "text",
    "webhook_url": "text",
    "status": "disabled",
    "consent_scopes": [
      "text"
    ],
    "routes": [
      {
        "hosts": [
          "text"
        ],
        "paths": [
          "text"
        ]
      }
    ],
    "tags": [
      "text"
    ],
    "permissions": {
      "viewers": [
        "text"
      ],
      "owners": [
        "text"
      ],
      "editors": [
        "text"
      ]
    },
    "security": "none"
  }
]

Create a new API specification for projects

post

This endpoint allows users to create a new API specification within a specified project. It is essential for registering APIs in the unified gateway, facilitating billing, usage tracking, and other protective measures. Ensure proper authentication is provided to access this functionality.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: api.catalogs.create is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

Body

application/json

idstringOptional

namestringOptional

codestringOptional

org_idstringOptional

summarystringOptional

pathstringOptional

iconstringOptional

urlstringOptional

documentation_urlstringOptional

terms_urlstringOptional

open_api_urlstringOptional

ping_api_urlstringOptional

statusstring · enumOptionalPossible values:

securitystring · enumOptionalPossible values:

Responses

200

OK

*/*

401

Unauthorized

*/*

post

/console/gateway/{projectId}

HTTPcURLJavaScriptPython

POST /console/gateway/{projectId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 243

{
  "id": "text",
  "name": "text",
  "code": "text",
  "org_id": "text",
  "summary": "text",
  "path": "text",
  "icon": "text",
  "url": "text",
  "documentation_url": "text",
  "terms_url": "text",
  "open_api_url": "text",
  "ping_api_url": "text",
  "status": "disabled",
  "security": "none"
}

{
  "id": "text",
  "name": "text",
  "code": "text",
  "summary": "text",
  "org_id": "text",
  "project_id": "text",
  "icon": "text",
  "creation_date": "2025-12-16T22:12:01.738Z",
  "external_id": "text",
  "url": "text",
  "documentation_url": "text",
  "terms_url": "text",
  "health_check_url": "text",
  "open_api_url": "text",
  "mock_api_url": "text",
  "ping_route": "text",
  "price_url": "text",
  "support_url": "text",
  "webhook_url": "text",
  "status": "disabled",
  "consent_scopes": [
    "text"
  ],
  "routes": [
    {
      "hosts": [
        "text"
      ],
      "paths": [
        "text"
      ]
    }
  ],
  "tags": [
    "text"
  ],
  "permissions": {
    "viewers": [
      "text"
    ],
    "owners": [
      "text"
    ],
    "editors": [
      "text"
    ]
  },
  "security": "none"
}

Retrieve the public IPs for external service security.

get

This endpoint returns the public IP addresses that should be used to secure your external services from unauthorized access. It is essential for configuring firewalls and ensuring that only trusted IPs can interact with your APIs. Use this information to enhance the security posture of your applications.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: api.catalogs.get is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/gateway/{projectId}/ips

HTTPcURLJavaScriptPython

GET /console/gateway/{projectId}/ips HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "allow_ips": [
    "text"
  ]
}

Update a specific API specification.

put

This endpoint allows you to update the details of a registered API. It is intended for users with appropriate permissions to modify API specifications within the project. Ensure that the provided data in the request body adheres to the expected format for successful updates.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: api.catalogs.update is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

projectIdstringRequired

serviceIdstringRequired

Body

application/json

idstringOptional

namestringOptional

codestringOptional

org_idstringOptional

summarystringOptional

pathstringOptional

iconstringOptional

urlstringOptional

documentation_urlstringOptional

terms_urlstringOptional

open_api_urlstringOptional

ping_api_urlstringOptional

statusstring · enumOptionalPossible values:

securitystring · enumOptionalPossible values:

Responses

200

OK

*/*

401

Unauthorized

*/*

put

/console/gateway/{projectId}/{serviceId}

HTTPcURLJavaScriptPython

PUT /console/gateway/{projectId}/{serviceId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 243

{
  "id": "text",
  "name": "text",
  "code": "text",
  "org_id": "text",
  "summary": "text",
  "path": "text",
  "icon": "text",
  "url": "text",
  "documentation_url": "text",
  "terms_url": "text",
  "open_api_url": "text",
  "ping_api_url": "text",
  "status": "disabled",
  "security": "none"
}

{
  "id": "text",
  "name": "text",
  "code": "text",
  "summary": "text",
  "org_id": "text",
  "project_id": "text",
  "icon": "text",
  "creation_date": "2025-12-16T22:12:01.738Z",
  "external_id": "text",
  "url": "text",
  "documentation_url": "text",
  "terms_url": "text",
  "health_check_url": "text",
  "open_api_url": "text",
  "mock_api_url": "text",
  "ping_route": "text",
  "price_url": "text",
  "support_url": "text",
  "webhook_url": "text",
  "status": "disabled",
  "consent_scopes": [
    "text"
  ],
  "routes": [
    {
      "hosts": [
        "text"
      ],
      "paths": [
        "text"
      ]
    }
  ],
  "tags": [
    "text"
  ],
  "permissions": {
    "viewers": [
      "text"
    ],
    "owners": [
      "text"
    ],
    "editors": [
      "text"
    ]
  },
  "security": "none"
}

Retrieve the API specification for a given service.

get

This endpoint returns the detailed API specification for the specified service ID. It is intended for users with appropriate access to understand the capabilities and configurations of the API. Ensure that you have the necessary permissions to access this information.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: api.catalogs.get is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

serviceIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/console/gateway/{serviceId}

HTTPcURLJavaScriptPython

GET /console/gateway/{serviceId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "code": "text",
  "summary": "text",
  "org_id": "text",
  "project_id": "text",
  "icon": "text",
  "creation_date": "2025-12-16T22:12:01.738Z",
  "external_id": "text",
  "url": "text",
  "documentation_url": "text",
  "terms_url": "text",
  "health_check_url": "text",
  "open_api_url": "text",
  "mock_api_url": "text",
  "ping_route": "text",
  "price_url": "text",
  "support_url": "text",
  "webhook_url": "text",
  "status": "disabled",
  "consent_scopes": [
    "text"
  ],
  "routes": [
    {
      "hosts": [
        "text"
      ],
      "paths": [
        "text"
      ]
    }
  ],
  "tags": [
    "text"
  ],
  "permissions": {
    "viewers": [
      "text"
    ],
    "owners": [
      "text"
    ],
    "editors": [
      "text"
    ]
  },
  "security": "none"
}

Delete an API from the catalog

delete

This operation removes an API from the system's catalog, ensuring it is no longer hosted or available for consumption. It is crucial for maintaining the integrity and relevance of the API offerings. Use this endpoint to manage your API lifecycle effectively.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: api.catalogs.delete is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

serviceIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

delete

/console/gateway/{serviceId}

HTTPcURLJavaScriptPython

DELETE /console/gateway/{serviceId} HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text",
  "code": "text",
  "summary": "text",
  "org_id": "text",
  "project_id": "text",
  "icon": "text",
  "creation_date": "2025-12-16T22:12:01.738Z",
  "external_id": "text",
  "url": "text",
  "documentation_url": "text",
  "terms_url": "text",
  "health_check_url": "text",
  "open_api_url": "text",
  "mock_api_url": "text",
  "ping_route": "text",
  "price_url": "text",
  "support_url": "text",
  "webhook_url": "text",
  "status": "disabled",
  "consent_scopes": [
    "text"
  ],
  "routes": [
    {
      "hosts": [
        "text"
      ],
      "paths": [
        "text"
      ]
    }
  ],
  "tags": [
    "text"
  ],
  "permissions": {
    "viewers": [
      "text"
    ],
    "owners": [
      "text"
    ],
    "editors": [
      "text"
    ]
  },
  "security": "none"
}