{ "openapi": "3.0.1", "info": { "title": "API7 Enterprise Developer Portal APIs", "description": "API7 Enterprise Developer Portal APIs are RESTful APIs that allow you to create and manage developer portal resources.\n\n## Base URL\n\nAll API paths are relative to your API7 Developer Portal address, e.g. `https://your-api7-developer-portal`.\n\n## Authentication\n\nEvery request must include a Developer Portal token:\n\n- **Bearer Token**: Pass a valid Developer Portal token in the `Authorization` HTTP header.\n\nMost developer resource requests must also include the active developer ID:\n\n- **Developer ID**: Pass the active developer ID in the `X-Portal-Developer-ID` HTTP header where required by the operation.", "version": "3.10.2" }, "servers": [], "security": [ { "BearerAuth": [] } ], "paths": { "/api/developers": { "get": { "tags": [ "Developer" ], "summary": "List Developers", "operationId": "listDevelopers", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "page", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "page_size", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "direction", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" }, "description": "Order to list the resources by. The sorting index follows the configuration of `order_by`.", "in": "query" }, { "name": "order_by", "in": "query", "description": "Index to order developers by.", "schema": { "type": "string", "default": "last_active_at", "enum": [ "last_active_at", "created_at" ] } }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Condition to search resources by.", "example": "version%3Dv2" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of developers.", "items": { "type": "object", "required": [ "id", "name", "created_at", "updated_at" ], "properties": { "id": { "description": "Developer ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "Developer name.", "example": "dev one" }, "last_active_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "created_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } }, "post": { "tags": [ "Developer" ], "summary": "Create a developer", "operationId": "createDeveloper", "security": [ { "BearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "developer_id" ], "properties": { "developer_id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "created_at", "updated_at" ], "properties": { "id": { "description": "Developer ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "Developer name.", "example": "dev one" }, "last_active_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "created_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/developers/{developer_id}": { "delete": { "tags": [ "Developer" ], "summary": "Delete a developer", "operationId": "deleteDeveloper", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "developer_id", "in": "path", "required": true, "description": "Developer ID.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The resource was deleted successfully." }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 404 ] }, "message": { "type": "string", "description": "The error message.", "example": "resource not found" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/api_products": { "get": { "tags": [ "API Product" ], "summary": "List all API products", "operationId": "listAPIProducts", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "page", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "page_size", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "direction", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" }, "description": "Order to list the resources by. The sorting index follows the configuration of `order_by`.", "in": "query" }, { "name": "order_by", "in": "query", "description": "Index to order resources by.", "schema": { "type": "string", "default": "updated_at", "enum": [ "created_at", "updated_at" ], "description": "Field used to order resources, either `created_at` or `updated_at`." } }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Condition to search resources by.", "example": "version%3Dv2" }, { "name": "subscription_status", "in": "query", "schema": { "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } }, { "name": "application_id", "in": "query", "required": false, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of API products.", "items": { "description": "The API product with subscription status.", "allOf": [ { "description": "The API product.", "oneOf": [ { "title": "Gateway API Product", "type": "object", "allOf": [ { "type": "object", "required": [ "type", "name", "auth", "status", "subscription_auto_approval", "can_view_unsubscribed", "visibility" ], "properties": { "type": { "type": "string", "enum": [ "gateway" ], "default": "gateway" }, "name": { "example": "Weather Insights API", "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100 }, "logo": { "type": "string", "description": "The base64-encoded logo image of the API product." }, "desc": { "type": "string", "description": "The description of the API product.", "example": "The Weather Insights API provides real-time and historical weather data for any location worldwide." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } }, "auth": { "type": "object", "description": "The authentication configuration of the API product.", "additionalProperties": false, "minProperties": 1, "example": { "key-auth": { "header": "apikey", "hide_credentials": false, "query": "apikey" } }, "properties": { "key-auth": { "type": "object", "additionalProperties": false, "description": "Key authentication configurations.", "properties": { "hide_credentials": { "type": "boolean", "default": false, "description": "If true, do not pass the header or query string with key to upstream services." }, "query": { "type": "string", "default": "apikey", "description": "The query string to get the key from. Lower priority than header." }, "header": { "type": "string", "default": "apikey", "description": "The header to get the key from." } } }, "basic-auth": { "type": "object", "additionalProperties": false, "description": "Basic authentication configurations.", "properties": { "hide_credentials": { "type": "boolean", "default": false, "description": "If true, do not pass the header or query string with key to upstream services." } } }, "dcr": { "type": "object", "additionalProperties": false, "description": "DCR authentication configurations.", "required": [ "dcr_provider_id" ], "properties": { "dcr_provider_id": { "description": "ID of the DCR provider.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } } } }, "status": { "type": "string", "description": "Status of the API product.", "enum": [ "draft", "published" ], "default": "draft" }, "subscription_auto_approval": { "type": "boolean", "default": false, "description": "If true, the subscription is automatically approved." }, "can_view_unsubscribed": { "type": "boolean", "description": "If true, developers can view the unsubscribed API.", "default": true }, "visibility": { "type": "string", "enum": [ "public", "logged_in" ], "default": "public", "description": "The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers." }, "raw_openapis": { "type": "array", "description": "An array of raw OpenAPI specifications. It is only returned when getting an API product.", "items": { "type": "string", "description": "The raw OpenAPI specification of the API product.", "example": "Raw OpenAPI spec" } }, "api_count": { "type": "number", "format": "int32", "description": "API count. It is only returned when listing API products.", "example": 10 } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] }, { "title": "External API Product", "type": "object", "allOf": [ { "allOf": [ { "type": "object", "required": [ "name", "type", "status", "visibility" ], "properties": { "type": { "type": "string", "description": "Type of API product.", "enum": [ "external" ], "default": "external" }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "raw_openapis": { "type": "array", "description": "An array of raw OpenAPI specifications. It is only returned when getting an API product.", "items": { "type": "string", "description": "The raw OpenAPI specification of the API product.", "example": "Raw OpenAPI spec" } }, "status": { "type": "string", "description": "Status of the API product.", "enum": [ "draft", "published" ], "default": "draft" }, "visibility": { "type": "string", "enum": [ "public", "logged_in" ], "default": "public", "description": "The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers." } } }, { "anyOf": [ { "type": "object", "required": [ "server_url" ], "properties": { "server_url": { "deprecated": true, "type": "string", "minLength": 1, "maxLength": 4096, "description": "The server URL. It should be configured if the server URL is not defined in the OpenAPI spec.", "example": "http://localhost:8080" } } }, { "type": "object", "required": [ "server_urls" ], "properties": { "server_urls": { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1, "maxLength": 4096 }, "description": "The server URLs. It should be configured if the server URLs are not defined in the OpenAPI spec.", "example": [ "http://localhost:8080", "http://localhost:8081" ] } } } ] } ] }, { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "desc": { "type": "string", "description": "Description." }, "api_desc": { "type": "string", "description": "API description." }, "api_count": { "type": "number", "format": "int32", "description": "API count.", "example": 10 } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } ] }, { "type": "object", "properties": { "subscription_status": { "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } } } ] } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/api_products/{api_product_id}": { "get": { "tags": [ "API Product" ], "summary": "Get an API Product for Developer Portal", "operationId": "getAPIProduct", "security": [ { "BearerAuth": [] } ], "parameters": [ { "name": "api_product_id", "description": "The unique identifier of the API product.", "in": "path", "required": true, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "description": "The API product with subscription status.", "allOf": [ { "description": "The API product.", "oneOf": [ { "title": "Gateway API Product", "type": "object", "allOf": [ { "type": "object", "required": [ "type", "name", "auth", "status", "subscription_auto_approval", "can_view_unsubscribed", "visibility" ], "properties": { "type": { "type": "string", "enum": [ "gateway" ], "default": "gateway" }, "name": { "example": "Weather Insights API", "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100 }, "logo": { "type": "string", "description": "The base64-encoded logo image of the API product." }, "desc": { "type": "string", "description": "The description of the API product.", "example": "The Weather Insights API provides real-time and historical weather data for any location worldwide." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } }, "auth": { "type": "object", "description": "The authentication configuration of the API product.", "additionalProperties": false, "minProperties": 1, "example": { "key-auth": { "header": "apikey", "hide_credentials": false, "query": "apikey" } }, "properties": { "key-auth": { "type": "object", "additionalProperties": false, "description": "Key authentication configurations.", "properties": { "hide_credentials": { "type": "boolean", "default": false, "description": "If true, do not pass the header or query string with key to upstream services." }, "query": { "type": "string", "default": "apikey", "description": "The query string to get the key from. Lower priority than header." }, "header": { "type": "string", "default": "apikey", "description": "The header to get the key from." } } }, "basic-auth": { "type": "object", "additionalProperties": false, "description": "Basic authentication configurations.", "properties": { "hide_credentials": { "type": "boolean", "default": false, "description": "If true, do not pass the header or query string with key to upstream services." } } }, "dcr": { "type": "object", "additionalProperties": false, "description": "DCR authentication configurations.", "required": [ "dcr_provider_id" ], "properties": { "dcr_provider_id": { "description": "ID of the DCR provider.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } } } }, "status": { "type": "string", "description": "Status of the API product.", "enum": [ "draft", "published" ], "default": "draft" }, "subscription_auto_approval": { "type": "boolean", "default": false, "description": "If true, the subscription is automatically approved." }, "can_view_unsubscribed": { "type": "boolean", "description": "If true, developers can view the unsubscribed API.", "default": true }, "visibility": { "type": "string", "enum": [ "public", "logged_in" ], "default": "public", "description": "The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers." }, "raw_openapis": { "type": "array", "description": "An array of raw OpenAPI specifications. It is only returned when getting an API product.", "items": { "type": "string", "description": "The raw OpenAPI specification of the API product.", "example": "Raw OpenAPI spec" } }, "api_count": { "type": "number", "format": "int32", "description": "API count. It is only returned when listing API products.", "example": 10 } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] }, { "title": "External API Product", "type": "object", "allOf": [ { "allOf": [ { "type": "object", "required": [ "name", "type", "status", "visibility" ], "properties": { "type": { "type": "string", "description": "Type of API product.", "enum": [ "external" ], "default": "external" }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "raw_openapis": { "type": "array", "description": "An array of raw OpenAPI specifications. It is only returned when getting an API product.", "items": { "type": "string", "description": "The raw OpenAPI specification of the API product.", "example": "Raw OpenAPI spec" } }, "status": { "type": "string", "description": "Status of the API product.", "enum": [ "draft", "published" ], "default": "draft" }, "visibility": { "type": "string", "enum": [ "public", "logged_in" ], "default": "public", "description": "The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers." } } }, { "anyOf": [ { "type": "object", "required": [ "server_url" ], "properties": { "server_url": { "deprecated": true, "type": "string", "minLength": 1, "maxLength": 4096, "description": "The server URL. It should be configured if the server URL is not defined in the OpenAPI spec.", "example": "http://localhost:8080" } } }, { "type": "object", "required": [ "server_urls" ], "properties": { "server_urls": { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1, "maxLength": 4096 }, "description": "The server URLs. It should be configured if the server URLs are not defined in the OpenAPI spec.", "example": [ "http://localhost:8080", "http://localhost:8081" ] } } } ] } ] }, { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "desc": { "type": "string", "description": "Description." }, "api_desc": { "type": "string", "description": "API description." }, "api_count": { "type": "number", "format": "int32", "description": "API count.", "example": 10 } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } ] }, { "type": "object", "properties": { "subscription_status": { "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } } } ] } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 404 ] }, "message": { "type": "string", "description": "The error message.", "example": "resource not found" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/api_products/{api_product_id}/subscriptions": { "post": { "tags": [ "API Product" ], "summary": "Create a subscription for an API Product.", "operationId": "createAPIProductSubscription", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "api_product_id", "description": "The unique identifier of the API product.", "in": "path", "required": true, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "description": "The request body for creating a subscription.", "type": "object", "properties": { "application_id": { "description": "Application ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, "required": [ "application_id" ] } } } }, "responses": { "201": { "description": "The resource was created successfully." }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/subscriptions": { "get": { "tags": [ "Subscription" ], "summary": "List subscriptions.", "operationId": "listSubscriptions", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "api_product_id", "description": "The API product ID.", "in": "query", "required": false, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, { "name": "application_id", "in": "query", "required": false, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } } }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Condition to search resources by.", "example": "version%3Dv2" }, { "name": "order_by", "in": "query", "schema": { "type": "string", "default": "subscribed_at", "enum": [ "developer_name", "subscribed_at" ] } }, { "name": "page", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "page_size", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "direction", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" }, "description": "Order to list the resources by. The sorting index follows the configuration of `order_by`.", "in": "query" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of subscriptions.", "items": { "type": "object", "required": [ "id", "developer_id", "developer_name", "application_id", "application_name", "api_product_id", "api_product_name", "status" ], "properties": { "id": { "type": "string", "description": "The ID of the subscription." }, "developer_id": { "type": "string" }, "developer_name": { "type": "string" }, "subscribed_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "application_id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "api_product_id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "api_product_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "status": { "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } } } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } }, "post": { "tags": [ "Subscription" ], "summary": "Create a subscription for an API Product", "operationId": "createSubscription", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "description": "The request body for creating subscriptions.", "type": "object", "properties": { "applications": { "type": "array", "minItems": 1, "items": { "description": "The applications ids", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, "api_products": { "type": "array", "minItems": 1, "items": { "description": "The api products ids", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } }, "required": [ "applications", "api_products" ] } } } }, "responses": { "201": { "description": "The resource was created successfully." }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/subscriptions/{subscription_id}": { "delete": { "tags": [ "Subscription" ], "summary": "Unsubscribe an API product for the given application", "operationId": "deleteSubscription", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "subscription_id", "in": "path", "required": true, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } ], "responses": { "204": { "description": "The resource was deleted successfully." }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 404 ] }, "message": { "type": "string", "description": "The error message.", "example": "resource not found" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/applications": { "post": { "tags": [ "Application" ], "summary": "Create an application by the logged in developer.", "operationId": "createDeveloperApplication", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "description": "Create an application request.", "properties": { "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "description": "The developer application.", "allOf": [ { "description": "The developer application response fields.", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } }, "get": { "tags": [ "Application" ], "summary": "List all applications for the logged in developer.", "operationId": "listDeveloperApplications", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "api_product_id", "description": "The API product ID.", "in": "query", "required": false, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Condition to search resources by.", "example": "version%3Dv2" }, { "name": "labels", "in": "query", "required": false, "description": "Label(s) to filter resources by. The format is `labels[key]=value` and should be URL-encoded.", "schema": { "type": "string", "minLength": 1, "example": "labels%5Bversion%5D=v2" } }, { "name": "order_by", "in": "query", "description": "Index to order resources by.", "schema": { "type": "string", "default": "updated_at", "enum": [ "created_at", "updated_at" ], "description": "Field used to order resources, either `created_at` or `updated_at`." } }, { "name": "page", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "page_size", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "direction", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" }, "description": "Order to list the resources by. The sorting index follows the configuration of `order_by`.", "in": "query" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of developer applications.", "items": { "description": "The developer application with subscription status.", "allOf": [ { "type": "object", "properties": { "subscription_status": { "description": "Indicates the subscription status of the application for a specific api_product. \nIt is only returned when it is necessary to check the subscription status of applications for a specific api_product.\n", "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } } }, { "description": "The developer application.", "allOf": [ { "description": "The developer application response fields.", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } ] } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/applications/{application_id}": { "get": { "tags": [ "Application" ], "summary": "Get an application for the logged in developer.", "operationId": "getDeveloperApplication", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "application_id", "in": "path", "required": true, "schema": { "default": "default", "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "description": "The developer application.", "allOf": [ { "description": "The developer application response fields.", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 404 ] }, "message": { "type": "string", "description": "The error message.", "example": "resource not found" } } } } } }, "500": { "description": "Internal server error." } } }, "put": { "tags": [ "Application" ], "summary": "Update an application basic information by the logged in developer.", "operationId": "updateDeveloperApplication", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "application_id", "in": "path", "required": true, "schema": { "default": "default", "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "description": "Create an application request.", "properties": { "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "description": "The developer application.", "allOf": [ { "description": "The developer application response fields.", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 404 ] }, "message": { "type": "string", "description": "The error message.", "example": "resource not found" } } } } } }, "500": { "description": "Internal server error." } } }, "delete": { "tags": [ "Application" ], "summary": "Delete an application by the logged in developer.", "operationId": "deleteDeveloperApplication", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "application_id", "in": "path", "required": true, "schema": { "default": "default", "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } ], "responses": { "204": { "description": "The resource was deleted successfully." }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 404 ] }, "message": { "type": "string", "description": "The error message.", "example": "resource not found" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/applications/{application_id}/credentials": { "post": { "tags": [ "Credential" ], "summary": "Create an application credential", "operationId": "createApplicationCredential", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "application_id", "in": "path", "required": true, "schema": { "default": "default", "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "description": "Create an application credential request.", "type": "object", "oneOf": [ { "description": "Create a Key Auth application credential request.", "allOf": [ { "type": "object", "properties": { "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "key-auth": { "type": "object", "nullable": true, "additionalProperties": false, "description": "Key Auth configuration. If null, key will be auto-generated." } } } ] }, { "description": "Create a Basic Auth application credential request.", "allOf": [ { "type": "object", "properties": { "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name", "basic-auth" ], "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "basic-auth": { "type": "object", "additionalProperties": false, "required": [ "username", "password" ], "properties": { "username": { "type": "string", "description": "Username." }, "password": { "type": "string", "description": "User password." } } } } } ] }, { "description": "Create an OAuth application credential request.", "allOf": [ { "type": "object", "properties": { "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "oauth" ], "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "oauth": { "type": "object", "required": [ "dcr_provider_id" ], "properties": { "dcr_provider_id": { "type": "string", "description": "The DCR provider ID." }, "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] } ] } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "description": "The application credential.", "allOf": [ { "description": "The application credential response.", "type": "object", "oneOf": [ { "description": "Key Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "key-auth": { "type": "object", "description": "Key Auth configuration.", "properties": { "key": { "type": "string", "description": "The key is only returned upon creation or regeneration." } } } } } ] }, { "description": "Basic Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "basic-auth": { "type": "object", "description": "Basic Auth configuration.", "properties": { "username": { "type": "string", "description": "The username." }, "password": { "type": "string", "description": "The password is only returned upon creation or regeneration." } } } } } ] }, { "description": "OAuth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "oauth" ], "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "oauth": { "type": "object", "required": [ "dcr_provider_id", "client_id" ], "properties": { "dcr_provider_id": { "type": "string", "description": "The DCR provider ID." }, "dcr_provider": { "type": "object", "required": [ "id", "name", "issuer" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "The name of the Dynamic Client Registration (DCR) Provider." }, "provider_type": { "type": "string", "enum": [ "oidc", "http_bridge" ], "description": "The type of DCR provider." }, "issuer": { "type": "string", "description": "The issuer URL of the Authorization Server." } } }, "client_id": { "type": "string", "description": "The client ID." }, "client_secret": { "type": "string", "description": "The client secret is only returned upon creation or regeneration." }, "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] } ] }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } }, "get": { "tags": [ "Credential" ], "summary": "List all credentials for the logged in developer", "operationId": "listApplicationCredentials", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "application_id", "in": "path", "required": true, "schema": { "default": "default", "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, { "name": "auth_method", "description": "The authentication method of the developer credential.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "key-auth", "basic-auth", "oauth" ] } }, { "name": "plugin_name", "description": "The plugin name of the application credential, recommended to use `auth_method` instead.", "in": "query", "required": false, "deprecated": true, "schema": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" } }, { "name": "page", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "page_size", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "direction", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" }, "description": "Order to list the resources by. The sorting index follows the configuration of `order_by`.", "in": "query" }, { "name": "order_by", "in": "query", "description": "Index to order credentials by.", "schema": { "type": "string", "default": "updated_at", "enum": [ "created_at", "updated_at", "name" ] } }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Condition to search resources by.", "example": "version%3Dv2" }, { "name": "labels", "in": "query", "required": false, "description": "Label(s) to filter resources by. The format is `labels[key]=value` and should be URL-encoded.", "schema": { "type": "string", "minLength": 1, "example": "labels%5Bversion%5D=v2" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of application credentials.", "items": { "description": "The application credential.", "allOf": [ { "description": "The application credential response.", "type": "object", "oneOf": [ { "description": "Key Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "key-auth": { "type": "object", "description": "Key Auth configuration.", "properties": { "key": { "type": "string", "description": "The key is only returned upon creation or regeneration." } } } } } ] }, { "description": "Basic Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "basic-auth": { "type": "object", "description": "Basic Auth configuration.", "properties": { "username": { "type": "string", "description": "The username." }, "password": { "type": "string", "description": "The password is only returned upon creation or regeneration." } } } } } ] }, { "description": "OAuth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "oauth" ], "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "oauth": { "type": "object", "required": [ "dcr_provider_id", "client_id" ], "properties": { "dcr_provider_id": { "type": "string", "description": "The DCR provider ID." }, "dcr_provider": { "type": "object", "required": [ "id", "name", "issuer" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "The name of the Dynamic Client Registration (DCR) Provider." }, "provider_type": { "type": "string", "enum": [ "oidc", "http_bridge" ], "description": "The type of DCR provider." }, "issuer": { "type": "string", "description": "The issuer URL of the Authorization Server." } } }, "client_id": { "type": "string", "description": "The client ID." }, "client_secret": { "type": "string", "description": "The client secret is only returned upon creation or regeneration." }, "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] } ] }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/applications/{application_id}/credentials/{credential_id}": { "get": { "tags": [ "Credential" ], "summary": "Get an application credential for Developer Portal", "operationId": "getApplicationCredential", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "application_id", "in": "path", "required": true, "schema": { "default": "default", "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, { "name": "credential_id", "description": "The unique identifier of the application credential.", "in": "path", "required": true, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "description": "The application credential.", "allOf": [ { "description": "The application credential response.", "type": "object", "oneOf": [ { "description": "Key Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "key-auth": { "type": "object", "description": "Key Auth configuration.", "properties": { "key": { "type": "string", "description": "The key is only returned upon creation or regeneration." } } } } } ] }, { "description": "Basic Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "basic-auth": { "type": "object", "description": "Basic Auth configuration.", "properties": { "username": { "type": "string", "description": "The username." }, "password": { "type": "string", "description": "The password is only returned upon creation or regeneration." } } } } } ] }, { "description": "OAuth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "oauth" ], "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "oauth": { "type": "object", "required": [ "dcr_provider_id", "client_id" ], "properties": { "dcr_provider_id": { "type": "string", "description": "The DCR provider ID." }, "dcr_provider": { "type": "object", "required": [ "id", "name", "issuer" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "The name of the Dynamic Client Registration (DCR) Provider." }, "provider_type": { "type": "string", "enum": [ "oidc", "http_bridge" ], "description": "The type of DCR provider." }, "issuer": { "type": "string", "description": "The issuer URL of the Authorization Server." } } }, "client_id": { "type": "string", "description": "The client ID." }, "client_secret": { "type": "string", "description": "The client secret is only returned upon creation or regeneration." }, "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] } ] }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 404 ] }, "message": { "type": "string", "description": "The error message.", "example": "resource not found" } } } } } }, "500": { "description": "Internal server error." } } }, "put": { "tags": [ "Credential" ], "summary": "Update an application credential for Developer Portal", "operationId": "upsertApplicationCredential", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "application_id", "in": "path", "required": true, "schema": { "default": "default", "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, { "name": "credential_id", "description": "The unique identifier of the application credential.", "in": "path", "required": true, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "description": "Update an application credential request.", "type": "object", "oneOf": [ { "description": "Update an application credential basics request.", "type": "object", "required": [ "type", "name" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "key-auth", "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "description": "Update an OAuth application credential request.", "type": "object", "required": [ "type", "oauth" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } }, "oauth": { "type": "object", "additionalProperties": false, "properties": { "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "description": "The application credential.", "allOf": [ { "description": "The application credential response.", "type": "object", "oneOf": [ { "description": "Key Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "key-auth": { "type": "object", "description": "Key Auth configuration.", "properties": { "key": { "type": "string", "description": "The key is only returned upon creation or regeneration." } } } } } ] }, { "description": "Basic Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "basic-auth": { "type": "object", "description": "Basic Auth configuration.", "properties": { "username": { "type": "string", "description": "The username." }, "password": { "type": "string", "description": "The password is only returned upon creation or regeneration." } } } } } ] }, { "description": "OAuth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "oauth" ], "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "oauth": { "type": "object", "required": [ "dcr_provider_id", "client_id" ], "properties": { "dcr_provider_id": { "type": "string", "description": "The DCR provider ID." }, "dcr_provider": { "type": "object", "required": [ "id", "name", "issuer" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "The name of the Dynamic Client Registration (DCR) Provider." }, "provider_type": { "type": "string", "enum": [ "oidc", "http_bridge" ], "description": "The type of DCR provider." }, "issuer": { "type": "string", "description": "The issuer URL of the Authorization Server." } } }, "client_id": { "type": "string", "description": "The client ID." }, "client_secret": { "type": "string", "description": "The client secret is only returned upon creation or regeneration." }, "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] } ] }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 404 ] }, "message": { "type": "string", "description": "The error message.", "example": "resource not found" } } } } } }, "500": { "description": "Internal server error." } } }, "delete": { "tags": [ "Credential" ], "summary": "Delete an application credential for Developer Portal", "operationId": "deleteApplicationCredential", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "application_id", "in": "path", "required": true, "schema": { "default": "default", "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, { "name": "credential_id", "description": "The unique identifier of the application credential.", "in": "path", "required": true, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } ], "responses": { "204": { "description": "The resource was deleted successfully." }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 404 ] }, "message": { "type": "string", "description": "The error message.", "example": "resource not found" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/applications/{application_id}/credentials/{credential_id}/regenerate": { "put": { "tags": [ "Credential" ], "summary": "Regenerate an application credential auth conf", "operationId": "regenerateApplicationCredential", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "application_id", "in": "path", "required": true, "schema": { "default": "default", "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, { "name": "credential_id", "description": "The unique identifier of the application credential.", "in": "path", "required": true, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "description": "Regenerate an application credential request.", "type": "object", "oneOf": [ { "description": "Regenerate a Key Auth application credential request.", "type": "object", "required": [ "type" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "key-auth": { "type": "object", "nullable": true, "additionalProperties": false, "description": "Key Auth configuration. If null, key will be auto-generated." } } }, { "description": "Regenerate a Basic Auth application credential request.", "type": "object", "required": [ "type", "basic-auth" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "basic-auth": { "type": "object", "additionalProperties": false, "required": [ "username", "password" ], "properties": { "username": { "type": "string", "description": "Username." }, "password": { "type": "string", "description": "User password." } } } } }, { "description": "Regenerate an OAuth application credential (rotate client secret).", "type": "object", "required": [ "type" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." } } } ] } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "description": "The application credential.", "allOf": [ { "description": "The application credential response.", "type": "object", "oneOf": [ { "description": "Key Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "key-auth": { "type": "object", "description": "Key Auth configuration.", "properties": { "key": { "type": "string", "description": "The key is only returned upon creation or regeneration." } } } } } ] }, { "description": "Basic Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "basic-auth": { "type": "object", "description": "Basic Auth configuration.", "properties": { "username": { "type": "string", "description": "The username." }, "password": { "type": "string", "description": "The password is only returned upon creation or regeneration." } } } } } ] }, { "description": "OAuth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "oauth" ], "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "oauth": { "type": "object", "required": [ "dcr_provider_id", "client_id" ], "properties": { "dcr_provider_id": { "type": "string", "description": "The DCR provider ID." }, "dcr_provider": { "type": "object", "required": [ "id", "name", "issuer" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "The name of the Dynamic Client Registration (DCR) Provider." }, "provider_type": { "type": "string", "enum": [ "oidc", "http_bridge" ], "description": "The type of DCR provider." }, "issuer": { "type": "string", "description": "The issuer URL of the Authorization Server." } } }, "client_id": { "type": "string", "description": "The client ID." }, "client_secret": { "type": "string", "description": "The client secret is only returned upon creation or regeneration." }, "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] } ] }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 404 ] }, "message": { "type": "string", "description": "The error message.", "example": "resource not found" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/applications/api_calls": { "get": { "tags": [ "API Calls" ], "summary": "Get API Calls", "description": "Retrieve a list of API calls made by the user.", "operationId": "getApiCalls", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "application_id", "in": "query", "required": false, "schema": { "type": "array", "items": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } }, { "name": "api_product_id", "description": "The API product IDs.", "in": "query", "required": false, "schema": { "type": "array", "items": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } }, { "name": "credential_id", "in": "query", "schema": { "type": "array", "items": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } }, { "in": "query", "name": "start_at", "required": true, "schema": { "type": "integer" } }, { "in": "query", "required": true, "name": "end_at", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of API calls.", "items": { "type": "object", "required": [ "api_product_id", "api_product_name", "hour_timestamp", "api_calls" ], "properties": { "api_product_id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "api_product_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "hour_timestamp": { "description": "The object timestamp.", "type": "integer", "minimum": 0, "example": 1742288230 }, "api_calls": { "type": "integer", "description": "The number of API calls." } } } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/credentials": { "get": { "tags": [ "Credential" ], "summary": "List all Credentials", "operationId": "listCredentials", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "application_id", "in": "query", "required": false, "schema": { "type": "array", "items": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } }, { "name": "auth_method", "description": "The authentication method of the developer credential.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "key-auth", "basic-auth", "oauth" ] } }, { "name": "plugin_name", "description": "The plugin name of the application credential, recommended to use `auth_method` instead.", "in": "query", "required": false, "deprecated": true, "schema": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" } }, { "name": "page", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "page_size", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "direction", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" }, "description": "Order to list the resources by. The sorting index follows the configuration of `order_by`.", "in": "query" }, { "name": "order_by", "in": "query", "description": "Index to order credentials by.", "schema": { "type": "string", "default": "updated_at", "enum": [ "created_at", "updated_at", "name" ] } }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Condition to search resources by.", "example": "version%3Dv2" }, { "name": "labels", "in": "query", "required": false, "description": "Label(s) to filter resources by. The format is `labels[key]=value` and should be URL-encoded.", "schema": { "type": "string", "minLength": 1, "example": "labels%5Bversion%5D=v2" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of application credentials.", "items": { "description": "The application credential.", "allOf": [ { "description": "The application credential response.", "type": "object", "oneOf": [ { "description": "Key Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "key-auth": { "type": "object", "description": "Key Auth configuration.", "properties": { "key": { "type": "string", "description": "The key is only returned upon creation or regeneration." } } } } } ] }, { "description": "Basic Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "basic-auth": { "type": "object", "description": "Basic Auth configuration.", "properties": { "username": { "type": "string", "description": "The username." }, "password": { "type": "string", "description": "The password is only returned upon creation or regeneration." } } } } } ] }, { "description": "OAuth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "oauth" ], "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "oauth": { "type": "object", "required": [ "dcr_provider_id", "client_id" ], "properties": { "dcr_provider_id": { "type": "string", "description": "The DCR provider ID." }, "dcr_provider": { "type": "object", "required": [ "id", "name", "issuer" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "The name of the Dynamic Client Registration (DCR) Provider." }, "provider_type": { "type": "string", "enum": [ "oidc", "http_bridge" ], "description": "The type of DCR provider." }, "issuer": { "type": "string", "description": "The issuer URL of the Authorization Server." } } }, "client_id": { "type": "string", "description": "The client ID." }, "client_secret": { "type": "string", "description": "The client secret is only returned upon creation or regeneration." }, "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] } ] }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/labels/{resource_type}": { "get": { "tags": [ "Label" ], "summary": "Get all labels of a resource type", "operationId": "listLabels", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "resource_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "developer_credential", "developer_application", "api_product" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "example": { "k8s/namespace": [ "api7-ingress-system", "default", "api7" ], "manager-by": [ "api7-ingress-controller", "apisix-ingress-controller" ] } } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/system_settings/smtp_server_status": { "get": { "tags": [ "System Settings" ], "summary": "Get SMTP server settings status", "operationId": "getSMTPServerStatus", "description": "Get SMTP server settings status.", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "enable" ], "properties": { "enable": { "type": "boolean", "description": "Enable SMTP Server." } } } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/system_settings/public_access": { "get": { "tags": [ "System Settings" ], "summary": "Get public access settings", "operationId": "getPublicAccessSettings", "security": [ { "BearerAuth": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "portal_public_access" ], "properties": { "portal_public_access": { "type": "boolean", "description": "If true, allow public access to the developer portal." } } } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/dcr_providers": { "get": { "tags": [ "DCR Provider" ], "summary": "List all DCR providers", "operationId": "listDCRProviders", "security": [ { "BearerAuth": [], "DeveloperIDHeader": [] } ], "parameters": [ { "name": "page", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "page_size", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "direction", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" }, "description": "Order to list the resources by. The sorting index follows the configuration of `order_by`.", "in": "query" }, { "name": "order_by", "in": "query", "description": "Index to order resources by.", "schema": { "type": "string", "default": "updated_at", "enum": [ "created_at", "updated_at" ], "description": "Field used to order resources, either `created_at` or `updated_at`." } }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Condition to search resources by.", "example": "version%3Dv2" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of DCR providers.", "items": { "type": "object", "required": [ "id", "name", "issuer" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "The name of the Dynamic Client Registration (DCR) Provider." }, "provider_type": { "type": "string", "enum": [ "oidc", "http_bridge" ], "description": "The type of DCR provider." }, "issuer": { "type": "string", "description": "The issuer URL of the Authorization Server." } } } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/approvals": { "get": { "tags": [ "Approval" ], "summary": "List approvals", "operationId": "listApprovals", "description": "List pending and processed approval workflow items for the current portal, such as API product subscriptions and developer registrations. Results are scoped to the portal of the request token.", "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string", "description": "Approval status.", "enum": [ "pending", "finished" ] } }, { "name": "result", "in": "query", "schema": { "type": "string", "description": "Approval outcome.", "enum": [ "accepted", "rejected", "cancelled" ] } }, { "name": "event", "in": "query", "schema": { "type": "string", "description": "Approval event.", "enum": [ "api_product_subscription", "developer_registration" ] } }, { "name": "resource_type", "in": "query", "schema": { "type": "string", "description": "Resource type.", "enum": [ "api_product", "developer" ] } }, { "name": "resource_name", "in": "query", "description": "Resource name.", "schema": { "type": "string" } }, { "name": "operator_name", "description": "Operator name.", "in": "query", "schema": { "type": "string" } }, { "name": "applicant_name", "in": "query", "description": "Applicant name.", "schema": { "type": "string" } }, { "name": "page", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "page_size", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, { "name": "direction", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" }, "description": "Order to list the resources by. The sorting index follows the configuration of `order_by`.", "in": "query" }, { "name": "order_by", "in": "query", "schema": { "type": "string", "default": "applied_at", "description": "Index to order approvals by.", "enum": [ "applied_at", "resource_name", "operated_at" ] } }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Condition to search resources by.", "example": "version%3Dv2" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of approvals.", "items": { "allOf": [ { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } }, { "type": "object", "required": [ "event", "status", "resource_type" ], "properties": { "event": { "type": "string", "description": "Approval event.", "enum": [ "api_product_subscription", "developer_registration" ] }, "status": { "type": "string", "description": "Approval status.", "enum": [ "pending", "finished" ] }, "result": { "type": "string", "description": "Approval outcome.", "enum": [ "accepted", "rejected", "cancelled" ] }, "resource_type": { "type": "string", "description": "Resource type.", "enum": [ "api_product", "developer" ] }, "resource_id": { "type": "string", "description": "The id of the resource being approved (e.g. the API product id)." }, "resource_name": { "type": "string", "description": "The name of the resource being approved." }, "applicant_id": { "type": "string", "description": "The id of the developer that submitted the request." }, "applicant_name": { "type": "string", "description": "The name of the developer that submitted the request." }, "operator_id": { "type": "string", "description": "The id of who processed the request. The literal value `developer_portal_admin` marks an approval processed through the developer portal by a platform admin; in that case read the real operator from `metadata`." }, "operator_name": { "type": "string", "description": "The name of who processed the request." }, "metadata": { "type": "string", "description": "Opaque JSON string with extra processing context. When `operator_id` is `developer_portal_admin`, it holds the acting platform admin's identity, e.g. `{\"operator_id\":\"...\",\"operator_name\":\"...\"}`." }, "applied_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "operated_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/approvals/{approval_id}/accept": { "post": { "tags": [ "Approval" ], "summary": "Accept an approval request", "operationId": "acceptApproval", "description": "Approve a specific workflow request and apply the corresponding portal-side change, such as granting an API product subscription or accepting a developer sign-up.", "parameters": [ { "name": "approval_id", "in": "path", "description": "Approval ID.", "required": true, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "string", "description": "Opaque JSON string stored on the approval. The developer portal uses it to carry the acting platform admin's identity." } } } } } }, "responses": { "200": { "description": "The operation was successful." }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 404 ] }, "message": { "type": "string", "description": "The error message.", "example": "resource not found" } } } } } }, "500": { "description": "Internal server error." } } } }, "/api/approvals/{approval_id}/reject": { "post": { "tags": [ "Approval" ], "summary": "Reject an approval request", "operationId": "rejectApproval", "description": "Reject a specific workflow approval request so the requested action is not applied.", "parameters": [ { "name": "approval_id", "in": "path", "description": "Approval ID.", "required": true, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "metadata": { "type": "string", "description": "Opaque JSON string stored on the approval. The developer portal uses it to carry the acting platform admin's identity." } } } } } }, "responses": { "200": { "description": "The operation was successful." }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 404 ] }, "message": { "type": "string", "description": "The error message.", "example": "resource not found" } } } } } }, "500": { "description": "Internal server error." } } } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer" }, "DeveloperIDHeader": { "type": "apiKey", "in": "header", "name": "X-Portal-Developer-ID" } }, "schemas": { "ID": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "Name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "Description": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "Total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." }, "LabelsMap": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } }, "DateTime": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "ResourceBasics": { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } }, "SubscriptionStatus": { "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] }, "Developer": { "type": "object", "required": [ "id", "name", "created_at", "updated_at" ], "properties": { "id": { "description": "Developer ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "Developer name.", "example": "dev one" }, "last_active_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "created_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } }, "CreateDeveloperReq": { "type": "object", "required": [ "developer_id" ], "properties": { "developer_id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } }, "DCRProviderForDeveloper": { "type": "object", "required": [ "id", "name", "issuer" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "The name of the Dynamic Client Registration (DCR) Provider." }, "provider_type": { "type": "string", "enum": [ "oidc", "http_bridge" ], "description": "The type of DCR provider." }, "issuer": { "type": "string", "description": "The issuer URL of the Authorization Server." } } }, "APIProduct": { "description": "The API product.", "oneOf": [ { "title": "Gateway API Product", "type": "object", "allOf": [ { "type": "object", "required": [ "type", "name", "auth", "status", "subscription_auto_approval", "can_view_unsubscribed", "visibility" ], "properties": { "type": { "type": "string", "enum": [ "gateway" ], "default": "gateway" }, "name": { "example": "Weather Insights API", "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100 }, "logo": { "type": "string", "description": "The base64-encoded logo image of the API product." }, "desc": { "type": "string", "description": "The description of the API product.", "example": "The Weather Insights API provides real-time and historical weather data for any location worldwide." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } }, "auth": { "type": "object", "description": "The authentication configuration of the API product.", "additionalProperties": false, "minProperties": 1, "example": { "key-auth": { "header": "apikey", "hide_credentials": false, "query": "apikey" } }, "properties": { "key-auth": { "type": "object", "additionalProperties": false, "description": "Key authentication configurations.", "properties": { "hide_credentials": { "type": "boolean", "default": false, "description": "If true, do not pass the header or query string with key to upstream services." }, "query": { "type": "string", "default": "apikey", "description": "The query string to get the key from. Lower priority than header." }, "header": { "type": "string", "default": "apikey", "description": "The header to get the key from." } } }, "basic-auth": { "type": "object", "additionalProperties": false, "description": "Basic authentication configurations.", "properties": { "hide_credentials": { "type": "boolean", "default": false, "description": "If true, do not pass the header or query string with key to upstream services." } } }, "dcr": { "type": "object", "additionalProperties": false, "description": "DCR authentication configurations.", "required": [ "dcr_provider_id" ], "properties": { "dcr_provider_id": { "description": "ID of the DCR provider.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } } } }, "status": { "type": "string", "description": "Status of the API product.", "enum": [ "draft", "published" ], "default": "draft" }, "subscription_auto_approval": { "type": "boolean", "default": false, "description": "If true, the subscription is automatically approved." }, "can_view_unsubscribed": { "type": "boolean", "description": "If true, developers can view the unsubscribed API.", "default": true }, "visibility": { "type": "string", "enum": [ "public", "logged_in" ], "default": "public", "description": "The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers." }, "raw_openapis": { "type": "array", "description": "An array of raw OpenAPI specifications. It is only returned when getting an API product.", "items": { "type": "string", "description": "The raw OpenAPI specification of the API product.", "example": "Raw OpenAPI spec" } }, "api_count": { "type": "number", "format": "int32", "description": "API count. It is only returned when listing API products.", "example": 10 } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] }, { "title": "External API Product", "type": "object", "allOf": [ { "allOf": [ { "type": "object", "required": [ "name", "type", "status", "visibility" ], "properties": { "type": { "type": "string", "description": "Type of API product.", "enum": [ "external" ], "default": "external" }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "raw_openapis": { "type": "array", "description": "An array of raw OpenAPI specifications. It is only returned when getting an API product.", "items": { "type": "string", "description": "The raw OpenAPI specification of the API product.", "example": "Raw OpenAPI spec" } }, "status": { "type": "string", "description": "Status of the API product.", "enum": [ "draft", "published" ], "default": "draft" }, "visibility": { "type": "string", "enum": [ "public", "logged_in" ], "default": "public", "description": "The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers." } } }, { "anyOf": [ { "type": "object", "required": [ "server_url" ], "properties": { "server_url": { "deprecated": true, "type": "string", "minLength": 1, "maxLength": 4096, "description": "The server URL. It should be configured if the server URL is not defined in the OpenAPI spec.", "example": "http://localhost:8080" } } }, { "type": "object", "required": [ "server_urls" ], "properties": { "server_urls": { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1, "maxLength": 4096 }, "description": "The server URLs. It should be configured if the server URLs are not defined in the OpenAPI spec.", "example": [ "http://localhost:8080", "http://localhost:8081" ] } } } ] } ] }, { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "desc": { "type": "string", "description": "Description." }, "api_desc": { "type": "string", "description": "API description." }, "api_count": { "type": "number", "format": "int32", "description": "API count.", "example": 10 } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } ] }, "DeveloperApplicationBasics": { "description": "The developer application response fields.", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, "DeveloperApplication": { "description": "The developer application.", "allOf": [ { "description": "The developer application response fields.", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] }, "DeveloperApplicationWithSubscriptionStatus": { "description": "The developer application with subscription status.", "allOf": [ { "type": "object", "properties": { "subscription_status": { "description": "Indicates the subscription status of the application for a specific api_product. \nIt is only returned when it is necessary to check the subscription status of applications for a specific api_product.\n", "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } } }, { "description": "The developer application.", "allOf": [ { "description": "The developer application response fields.", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } ] }, "CreateDeveloperApplicationReq": { "description": "Create an application request.", "properties": { "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, "CredentialType": { "type": "string", "description": "The type of the credential.", "enum": [ "key-auth", "basic-auth", "oauth" ] }, "ApplicationCredentialBasicsCommon": { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, "ApplicationCredentialBasics": { "description": "The application credential response.", "type": "object", "oneOf": [ { "description": "Key Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "key-auth": { "type": "object", "description": "Key Auth configuration.", "properties": { "key": { "type": "string", "description": "The key is only returned upon creation or regeneration." } } } } } ] }, { "description": "Basic Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "basic-auth": { "type": "object", "description": "Basic Auth configuration.", "properties": { "username": { "type": "string", "description": "The username." }, "password": { "type": "string", "description": "The password is only returned upon creation or regeneration." } } } } } ] }, { "description": "OAuth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "oauth" ], "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "oauth": { "type": "object", "required": [ "dcr_provider_id", "client_id" ], "properties": { "dcr_provider_id": { "type": "string", "description": "The DCR provider ID." }, "dcr_provider": { "type": "object", "required": [ "id", "name", "issuer" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "The name of the Dynamic Client Registration (DCR) Provider." }, "provider_type": { "type": "string", "enum": [ "oidc", "http_bridge" ], "description": "The type of DCR provider." }, "issuer": { "type": "string", "description": "The issuer URL of the Authorization Server." } } }, "client_id": { "type": "string", "description": "The client ID." }, "client_secret": { "type": "string", "description": "The client secret is only returned upon creation or regeneration." }, "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] } ] }, "KeyAuthApplicationCredentialBasics": { "description": "Key Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "key-auth": { "type": "object", "description": "Key Auth configuration.", "properties": { "key": { "type": "string", "description": "The key is only returned upon creation or regeneration." } } } } } ] }, "BasicAuthApplicationCredentialBasics": { "description": "Basic Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "basic-auth": { "type": "object", "description": "Basic Auth configuration.", "properties": { "username": { "type": "string", "description": "The username." }, "password": { "type": "string", "description": "The password is only returned upon creation or regeneration." } } } } } ] }, "OAuthApplicationCredentialBasics": { "description": "OAuth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "oauth" ], "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "oauth": { "type": "object", "required": [ "dcr_provider_id", "client_id" ], "properties": { "dcr_provider_id": { "type": "string", "description": "The DCR provider ID." }, "dcr_provider": { "type": "object", "required": [ "id", "name", "issuer" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "The name of the Dynamic Client Registration (DCR) Provider." }, "provider_type": { "type": "string", "enum": [ "oidc", "http_bridge" ], "description": "The type of DCR provider." }, "issuer": { "type": "string", "description": "The issuer URL of the Authorization Server." } } }, "client_id": { "type": "string", "description": "The client ID." }, "client_secret": { "type": "string", "description": "The client secret is only returned upon creation or regeneration." }, "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] }, "ApplicationCredential": { "description": "The application credential.", "allOf": [ { "description": "The application credential response.", "type": "object", "oneOf": [ { "description": "Key Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "key-auth": { "type": "object", "description": "Key Auth configuration.", "properties": { "key": { "type": "string", "description": "The key is only returned upon creation or regeneration." } } } } } ] }, { "description": "Basic Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "basic-auth": { "type": "object", "description": "Basic Auth configuration.", "properties": { "username": { "type": "string", "description": "The username." }, "password": { "type": "string", "description": "The password is only returned upon creation or regeneration." } } } } } ] }, { "description": "OAuth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "oauth" ], "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "oauth": { "type": "object", "required": [ "dcr_provider_id", "client_id" ], "properties": { "dcr_provider_id": { "type": "string", "description": "The DCR provider ID." }, "dcr_provider": { "type": "object", "required": [ "id", "name", "issuer" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "The name of the Dynamic Client Registration (DCR) Provider." }, "provider_type": { "type": "string", "enum": [ "oidc", "http_bridge" ], "description": "The type of DCR provider." }, "issuer": { "type": "string", "description": "The issuer URL of the Authorization Server." } } }, "client_id": { "type": "string", "description": "The client ID." }, "client_secret": { "type": "string", "description": "The client secret is only returned upon creation or regeneration." }, "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] } ] }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] }, "CreateApplicationCredentialReqCommon": { "type": "object", "properties": { "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, "CreateApplicationCredentialReq": { "description": "Create an application credential request.", "type": "object", "oneOf": [ { "description": "Create a Key Auth application credential request.", "allOf": [ { "type": "object", "properties": { "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "key-auth": { "type": "object", "nullable": true, "additionalProperties": false, "description": "Key Auth configuration. If null, key will be auto-generated." } } } ] }, { "description": "Create a Basic Auth application credential request.", "allOf": [ { "type": "object", "properties": { "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name", "basic-auth" ], "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "basic-auth": { "type": "object", "additionalProperties": false, "required": [ "username", "password" ], "properties": { "username": { "type": "string", "description": "Username." }, "password": { "type": "string", "description": "User password." } } } } } ] }, { "description": "Create an OAuth application credential request.", "allOf": [ { "type": "object", "properties": { "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "oauth" ], "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "oauth": { "type": "object", "required": [ "dcr_provider_id" ], "properties": { "dcr_provider_id": { "type": "string", "description": "The DCR provider ID." }, "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] } ] }, "CreateKeyAuthApplicationCredentialReq": { "description": "Create a Key Auth application credential request.", "allOf": [ { "type": "object", "properties": { "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "key-auth": { "type": "object", "nullable": true, "additionalProperties": false, "description": "Key Auth configuration. If null, key will be auto-generated." } } } ] }, "CreateBasicAuthApplicationCredentialReq": { "description": "Create a Basic Auth application credential request.", "allOf": [ { "type": "object", "properties": { "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name", "basic-auth" ], "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "basic-auth": { "type": "object", "additionalProperties": false, "required": [ "username", "password" ], "properties": { "username": { "type": "string", "description": "Username." }, "password": { "type": "string", "description": "User password." } } } } } ] }, "CreateOAuthApplicationCredentialReq": { "description": "Create an OAuth application credential request.", "allOf": [ { "type": "object", "properties": { "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "oauth" ], "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "oauth": { "type": "object", "required": [ "dcr_provider_id" ], "properties": { "dcr_provider_id": { "type": "string", "description": "The DCR provider ID." }, "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] }, "UpdateApplicationCredentialReq": { "description": "Update an application credential request.", "type": "object", "oneOf": [ { "description": "Update an application credential basics request.", "type": "object", "required": [ "type", "name" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "key-auth", "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "description": "Update an OAuth application credential request.", "type": "object", "required": [ "type", "oauth" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } }, "oauth": { "type": "object", "additionalProperties": false, "properties": { "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] }, "UpdateApplicationCredentialBasicsReq": { "description": "Update an application credential basics request.", "type": "object", "required": [ "type", "name" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "key-auth", "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, "UpdateOAuthApplicationCredentialReq": { "description": "Update an OAuth application credential request.", "type": "object", "required": [ "type", "oauth" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } }, "oauth": { "type": "object", "additionalProperties": false, "properties": { "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } }, "RegenerateApplicationCredentialReq": { "description": "Regenerate an application credential request.", "type": "object", "oneOf": [ { "description": "Regenerate a Key Auth application credential request.", "type": "object", "required": [ "type" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "key-auth": { "type": "object", "nullable": true, "additionalProperties": false, "description": "Key Auth configuration. If null, key will be auto-generated." } } }, { "description": "Regenerate a Basic Auth application credential request.", "type": "object", "required": [ "type", "basic-auth" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "basic-auth": { "type": "object", "additionalProperties": false, "required": [ "username", "password" ], "properties": { "username": { "type": "string", "description": "Username." }, "password": { "type": "string", "description": "User password." } } } } }, { "description": "Regenerate an OAuth application credential (rotate client secret).", "type": "object", "required": [ "type" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." } } } ] }, "RegenerateKeyAuthApplicationCredentialReq": { "description": "Regenerate a Key Auth application credential request.", "type": "object", "required": [ "type" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "key-auth": { "type": "object", "nullable": true, "additionalProperties": false, "description": "Key Auth configuration. If null, key will be auto-generated." } } }, "RegenerateBasicAuthApplicationCredentialReq": { "description": "Regenerate a Basic Auth application credential request.", "type": "object", "required": [ "type", "basic-auth" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "basic-auth": { "type": "object", "additionalProperties": false, "required": [ "username", "password" ], "properties": { "username": { "type": "string", "description": "Username." }, "password": { "type": "string", "description": "User password." } } } } }, "RegenerateOAuthApplicationCredentialReq": { "description": "Regenerate an OAuth application credential (rotate client secret).", "type": "object", "required": [ "type" ], "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." } } }, "Subscription": { "type": "object", "required": [ "id", "developer_id", "developer_name", "application_id", "application_name", "api_product_id", "api_product_name", "status" ], "properties": { "id": { "type": "string", "description": "The ID of the subscription." }, "developer_id": { "type": "string" }, "developer_name": { "type": "string" }, "subscribed_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "application_id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "api_product_id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "api_product_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "status": { "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } } }, "CreateAPIProductSubscriptionReq": { "description": "The request body for creating a subscription.", "type": "object", "properties": { "application_id": { "description": "Application ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, "required": [ "application_id" ] }, "CreateSubscriptionReq": { "description": "The request body for creating subscriptions.", "type": "object", "properties": { "applications": { "type": "array", "minItems": 1, "items": { "description": "The applications ids", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, "api_products": { "type": "array", "minItems": 1, "items": { "description": "The api products ids", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } }, "required": [ "applications", "api_products" ] }, "AllLabels": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "example": { "k8s/namespace": [ "api7-ingress-system", "default", "api7" ], "manager-by": [ "api7-ingress-controller", "apisix-ingress-controller" ] } }, "PortalPublicAccess": { "type": "object", "additionalProperties": false, "required": [ "portal_public_access" ], "properties": { "portal_public_access": { "type": "boolean", "description": "If true, allow public access to the developer portal." } } }, "SMTPServerSettingsStatus": { "type": "object", "required": [ "enable" ], "properties": { "enable": { "type": "boolean", "description": "Enable SMTP Server." } } }, "APICall": { "type": "object", "required": [ "api_product_id", "api_product_name", "hour_timestamp", "api_calls" ], "properties": { "api_product_id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "api_product_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "hour_timestamp": { "description": "The object timestamp.", "type": "integer", "minimum": 0, "example": 1742288230 }, "api_calls": { "type": "integer", "description": "The number of API calls." } } }, "APIProductWithSubscriptionStatus": { "description": "The API product with subscription status.", "allOf": [ { "description": "The API product.", "oneOf": [ { "title": "Gateway API Product", "type": "object", "allOf": [ { "type": "object", "required": [ "type", "name", "auth", "status", "subscription_auto_approval", "can_view_unsubscribed", "visibility" ], "properties": { "type": { "type": "string", "enum": [ "gateway" ], "default": "gateway" }, "name": { "example": "Weather Insights API", "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100 }, "logo": { "type": "string", "description": "The base64-encoded logo image of the API product." }, "desc": { "type": "string", "description": "The description of the API product.", "example": "The Weather Insights API provides real-time and historical weather data for any location worldwide." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } }, "auth": { "type": "object", "description": "The authentication configuration of the API product.", "additionalProperties": false, "minProperties": 1, "example": { "key-auth": { "header": "apikey", "hide_credentials": false, "query": "apikey" } }, "properties": { "key-auth": { "type": "object", "additionalProperties": false, "description": "Key authentication configurations.", "properties": { "hide_credentials": { "type": "boolean", "default": false, "description": "If true, do not pass the header or query string with key to upstream services." }, "query": { "type": "string", "default": "apikey", "description": "The query string to get the key from. Lower priority than header." }, "header": { "type": "string", "default": "apikey", "description": "The header to get the key from." } } }, "basic-auth": { "type": "object", "additionalProperties": false, "description": "Basic authentication configurations.", "properties": { "hide_credentials": { "type": "boolean", "default": false, "description": "If true, do not pass the header or query string with key to upstream services." } } }, "dcr": { "type": "object", "additionalProperties": false, "description": "DCR authentication configurations.", "required": [ "dcr_provider_id" ], "properties": { "dcr_provider_id": { "description": "ID of the DCR provider.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } } } }, "status": { "type": "string", "description": "Status of the API product.", "enum": [ "draft", "published" ], "default": "draft" }, "subscription_auto_approval": { "type": "boolean", "default": false, "description": "If true, the subscription is automatically approved." }, "can_view_unsubscribed": { "type": "boolean", "description": "If true, developers can view the unsubscribed API.", "default": true }, "visibility": { "type": "string", "enum": [ "public", "logged_in" ], "default": "public", "description": "The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers." }, "raw_openapis": { "type": "array", "description": "An array of raw OpenAPI specifications. It is only returned when getting an API product.", "items": { "type": "string", "description": "The raw OpenAPI specification of the API product.", "example": "Raw OpenAPI spec" } }, "api_count": { "type": "number", "format": "int32", "description": "API count. It is only returned when listing API products.", "example": 10 } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] }, { "title": "External API Product", "type": "object", "allOf": [ { "allOf": [ { "type": "object", "required": [ "name", "type", "status", "visibility" ], "properties": { "type": { "type": "string", "description": "Type of API product.", "enum": [ "external" ], "default": "external" }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "raw_openapis": { "type": "array", "description": "An array of raw OpenAPI specifications. It is only returned when getting an API product.", "items": { "type": "string", "description": "The raw OpenAPI specification of the API product.", "example": "Raw OpenAPI spec" } }, "status": { "type": "string", "description": "Status of the API product.", "enum": [ "draft", "published" ], "default": "draft" }, "visibility": { "type": "string", "enum": [ "public", "logged_in" ], "default": "public", "description": "The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers." } } }, { "anyOf": [ { "type": "object", "required": [ "server_url" ], "properties": { "server_url": { "deprecated": true, "type": "string", "minLength": 1, "maxLength": 4096, "description": "The server URL. It should be configured if the server URL is not defined in the OpenAPI spec.", "example": "http://localhost:8080" } } }, { "type": "object", "required": [ "server_urls" ], "properties": { "server_urls": { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1, "maxLength": 4096 }, "description": "The server URLs. It should be configured if the server URLs are not defined in the OpenAPI spec.", "example": [ "http://localhost:8080", "http://localhost:8081" ] } } } ] } ] }, { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "desc": { "type": "string", "description": "Description." }, "api_desc": { "type": "string", "description": "API description." }, "api_count": { "type": "number", "format": "int32", "description": "API count.", "example": 10 } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } ] }, { "type": "object", "properties": { "subscription_status": { "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } } } ] }, "Visibility": { "type": "string", "enum": [ "public", "logged_in" ], "default": "public", "description": "The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers." }, "APIProductStatus": { "type": "string", "description": "Status of the API product.", "enum": [ "draft", "published" ], "default": "draft" } }, "parameters": { "Page": { "name": "page", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Page number of the listed resources. Used together with `page_size`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, "PageSize": { "name": "page_size", "schema": { "type": "integer", "format": "int32", "minimum": 1 }, "description": "Number of resources listed per page. Used together with `page`. For example, when there are 13 resources in total, if the query parameters are `page=1&page_size=10`, the GET response will show the route `total` as `13` and display 10 resources in the first page. If the query parameters are `page=2&page_size=10`, the GET response will show the route `total` as `13` and display 3 resources in the second page.", "in": "query" }, "Direction": { "name": "direction", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" }, "description": "Order to list the resources by. The sorting index follows the configuration of `order_by`.", "in": "query" }, "OrderBy": { "name": "order_by", "in": "query", "description": "Index to order resources by.", "schema": { "type": "string", "default": "updated_at", "enum": [ "created_at", "updated_at" ], "description": "Field used to order resources, either `created_at` or `updated_at`." } }, "Search": { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Condition to search resources by.", "example": "version%3Dv2" }, "SubscriptionsOrderBy": { "name": "order_by", "in": "query", "schema": { "type": "string", "default": "subscribed_at", "enum": [ "developer_name", "subscribed_at" ] } }, "ApplicationID": { "name": "application_id", "in": "path", "required": true, "schema": { "default": "default", "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, "ApplicationIDInQuery": { "name": "application_id", "in": "query", "required": false, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, "ApplicationsIDs": { "name": "application_id", "in": "query", "required": false, "schema": { "type": "array", "items": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } }, "ApplicationCredentialID": { "name": "credential_id", "description": "The unique identifier of the application credential.", "in": "path", "required": true, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, "AuthMethod": { "name": "auth_method", "description": "The authentication method of the developer credential.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "key-auth", "basic-auth", "oauth" ] } }, "ApplicationCredentialPluginName": { "name": "plugin_name", "description": "The plugin name of the application credential, recommended to use `auth_method` instead.", "in": "query", "required": false, "deprecated": true, "schema": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" } }, "CredentialOrderBy": { "name": "order_by", "in": "query", "description": "Index to order credentials by.", "schema": { "type": "string", "default": "updated_at", "enum": [ "created_at", "updated_at", "name" ] } }, "APIProductSubscriptionStatus": { "name": "subscription_status", "in": "query", "schema": { "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } }, "SubscriptionStatusInQuery": { "name": "status", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } } }, "DeveloperOrderBy": { "name": "order_by", "in": "query", "description": "Index to order developers by.", "schema": { "type": "string", "default": "last_active_at", "enum": [ "last_active_at", "created_at" ] } }, "DeveloperID": { "name": "developer_id", "in": "path", "required": true, "description": "Developer ID.", "schema": { "type": "string" } }, "StartAt": { "in": "query", "name": "start_at", "required": true, "schema": { "type": "integer" } }, "EndAt": { "in": "query", "required": true, "name": "end_at", "schema": { "type": "integer" } }, "APIProductID": { "name": "api_product_id", "description": "The unique identifier of the API product.", "in": "path", "required": true, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, "APIProductIDInQuery": { "name": "api_product_id", "description": "The API product ID.", "in": "query", "required": false, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, "APIProductIDs": { "name": "api_product_id", "description": "The API product IDs.", "in": "query", "required": false, "schema": { "type": "array", "items": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } }, "APIProductServiceIDInQuery": { "name": "service_id", "description": "The unique identifier of the service in the API product.", "in": "query", "required": true, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, "SubscriptionID": { "name": "subscription_id", "in": "path", "required": true, "schema": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } }, "CredentialIDs": { "name": "credential_id", "in": "query", "schema": { "type": "array", "items": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } }, "LabelsMapInQuery": { "name": "labels", "in": "query", "required": false, "description": "Label(s) to filter resources by. The format is `labels[key]=value` and should be URL-encoded.", "schema": { "type": "string", "minLength": 1, "example": "labels%5Bversion%5D=v2" } }, "DeveloperPortalLabelResourceType": { "name": "resource_type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "developer_credential", "developer_application", "api_product" ] } } }, "responses": { "response200": { "description": "The operation was successful." }, "response201": { "description": "The resource was created successfully." }, "response204": { "description": "The resource was deleted successfully." }, "response400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 400 ] }, "message": { "type": "string", "description": "The error message.", "example": "error message" } } } } } }, "response401": { "description": "Unauthorized.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 401 ] }, "message": { "type": "string", "description": "The error message.", "example": "unauthorized" } } } } } }, "response404": { "description": "Resource not found.", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "message" ], "properties": { "status": { "type": "integer", "description": "The HTTP status code of the error response.", "enum": [ 404 ] }, "message": { "type": "string", "description": "The error message.", "example": "resource not found" } } } } } }, "response500": { "description": "Internal server error." }, "DeveloperApplicationResponse": { "description": "", "content": { "application/json": { "schema": { "description": "The developer application.", "allOf": [ { "description": "The developer application response fields.", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } } } }, "ListDeveloperApplicationResponse": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of developer applications.", "items": { "description": "The developer application with subscription status.", "allOf": [ { "type": "object", "properties": { "subscription_status": { "description": "Indicates the subscription status of the application for a specific api_product. \nIt is only returned when it is necessary to check the subscription status of applications for a specific api_product.\n", "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } } }, { "description": "The developer application.", "allOf": [ { "description": "The developer application response fields.", "type": "object", "required": [ "name" ], "properties": { "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } ] } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "ApplicationCredentialResponse": { "description": "", "content": { "application/json": { "schema": { "description": "The application credential.", "allOf": [ { "description": "The application credential response.", "type": "object", "oneOf": [ { "description": "Key Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "key-auth": { "type": "object", "description": "Key Auth configuration.", "properties": { "key": { "type": "string", "description": "The key is only returned upon creation or regeneration." } } } } } ] }, { "description": "Basic Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "basic-auth": { "type": "object", "description": "Basic Auth configuration.", "properties": { "username": { "type": "string", "description": "The username." }, "password": { "type": "string", "description": "The password is only returned upon creation or regeneration." } } } } } ] }, { "description": "OAuth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "oauth" ], "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "oauth": { "type": "object", "required": [ "dcr_provider_id", "client_id" ], "properties": { "dcr_provider_id": { "type": "string", "description": "The DCR provider ID." }, "dcr_provider": { "type": "object", "required": [ "id", "name", "issuer" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "The name of the Dynamic Client Registration (DCR) Provider." }, "provider_type": { "type": "string", "enum": [ "oidc", "http_bridge" ], "description": "The type of DCR provider." }, "issuer": { "type": "string", "description": "The issuer URL of the Authorization Server." } } }, "client_id": { "type": "string", "description": "The client ID." }, "client_secret": { "type": "string", "description": "The client secret is only returned upon creation or regeneration." }, "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] } ] }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } } } }, "ListApplicationCredentialResponse": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of application credentials.", "items": { "description": "The application credential.", "allOf": [ { "description": "The application credential response.", "type": "object", "oneOf": [ { "description": "Key Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "key-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "key-auth": { "type": "object", "description": "Key Auth configuration.", "properties": { "key": { "type": "string", "description": "The key is only returned upon creation or regeneration." } } } } } ] }, { "description": "Basic Auth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "name" ], "properties": { "type": { "type": "string", "enum": [ "basic-auth" ], "description": "The credential type." }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "basic-auth": { "type": "object", "description": "Basic Auth configuration.", "properties": { "username": { "type": "string", "description": "The username." }, "password": { "type": "string", "description": "The password is only returned upon creation or regeneration." } } } } } ] }, { "description": "OAuth application credential response.", "allOf": [ { "type": "object", "required": [ "application_id", "application_name" ], "properties": { "application_id": { "description": "Application ID.", "example": "default", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256 }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "desc": { "description": "The object description.", "type": "string", "maxLength": 65536, "example": "Object description." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } } } }, { "type": "object", "required": [ "type", "oauth" ], "properties": { "type": { "type": "string", "enum": [ "oauth" ], "description": "The credential type." }, "oauth": { "type": "object", "required": [ "dcr_provider_id", "client_id" ], "properties": { "dcr_provider_id": { "type": "string", "description": "The DCR provider ID." }, "dcr_provider": { "type": "object", "required": [ "id", "name", "issuer" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "The name of the Dynamic Client Registration (DCR) Provider." }, "provider_type": { "type": "string", "enum": [ "oidc", "http_bridge" ], "description": "The type of DCR provider." }, "issuer": { "type": "string", "description": "The issuer URL of the Authorization Server." } } }, "client_id": { "type": "string", "description": "The client ID." }, "client_secret": { "type": "string", "description": "The client secret is only returned upon creation or regeneration." }, "redirect_uris": { "type": "array", "description": "The redirect URIs.", "items": { "type": "string", "minLength": 1 } } } } } } ] } ] }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "APIProductResponse": { "description": "", "content": { "application/json": { "schema": { "description": "The API product with subscription status.", "allOf": [ { "description": "The API product.", "oneOf": [ { "title": "Gateway API Product", "type": "object", "allOf": [ { "type": "object", "required": [ "type", "name", "auth", "status", "subscription_auto_approval", "can_view_unsubscribed", "visibility" ], "properties": { "type": { "type": "string", "enum": [ "gateway" ], "default": "gateway" }, "name": { "example": "Weather Insights API", "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100 }, "logo": { "type": "string", "description": "The base64-encoded logo image of the API product." }, "desc": { "type": "string", "description": "The description of the API product.", "example": "The Weather Insights API provides real-time and historical weather data for any location worldwide." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } }, "auth": { "type": "object", "description": "The authentication configuration of the API product.", "additionalProperties": false, "minProperties": 1, "example": { "key-auth": { "header": "apikey", "hide_credentials": false, "query": "apikey" } }, "properties": { "key-auth": { "type": "object", "additionalProperties": false, "description": "Key authentication configurations.", "properties": { "hide_credentials": { "type": "boolean", "default": false, "description": "If true, do not pass the header or query string with key to upstream services." }, "query": { "type": "string", "default": "apikey", "description": "The query string to get the key from. Lower priority than header." }, "header": { "type": "string", "default": "apikey", "description": "The header to get the key from." } } }, "basic-auth": { "type": "object", "additionalProperties": false, "description": "Basic authentication configurations.", "properties": { "hide_credentials": { "type": "boolean", "default": false, "description": "If true, do not pass the header or query string with key to upstream services." } } }, "dcr": { "type": "object", "additionalProperties": false, "description": "DCR authentication configurations.", "required": [ "dcr_provider_id" ], "properties": { "dcr_provider_id": { "description": "ID of the DCR provider.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } } } }, "status": { "type": "string", "description": "Status of the API product.", "enum": [ "draft", "published" ], "default": "draft" }, "subscription_auto_approval": { "type": "boolean", "default": false, "description": "If true, the subscription is automatically approved." }, "can_view_unsubscribed": { "type": "boolean", "description": "If true, developers can view the unsubscribed API.", "default": true }, "visibility": { "type": "string", "enum": [ "public", "logged_in" ], "default": "public", "description": "The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers." }, "raw_openapis": { "type": "array", "description": "An array of raw OpenAPI specifications. It is only returned when getting an API product.", "items": { "type": "string", "description": "The raw OpenAPI specification of the API product.", "example": "Raw OpenAPI spec" } }, "api_count": { "type": "number", "format": "int32", "description": "API count. It is only returned when listing API products.", "example": 10 } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] }, { "title": "External API Product", "type": "object", "allOf": [ { "allOf": [ { "type": "object", "required": [ "name", "type", "status", "visibility" ], "properties": { "type": { "type": "string", "description": "Type of API product.", "enum": [ "external" ], "default": "external" }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "raw_openapis": { "type": "array", "description": "An array of raw OpenAPI specifications. It is only returned when getting an API product.", "items": { "type": "string", "description": "The raw OpenAPI specification of the API product.", "example": "Raw OpenAPI spec" } }, "status": { "type": "string", "description": "Status of the API product.", "enum": [ "draft", "published" ], "default": "draft" }, "visibility": { "type": "string", "enum": [ "public", "logged_in" ], "default": "public", "description": "The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers." } } }, { "anyOf": [ { "type": "object", "required": [ "server_url" ], "properties": { "server_url": { "deprecated": true, "type": "string", "minLength": 1, "maxLength": 4096, "description": "The server URL. It should be configured if the server URL is not defined in the OpenAPI spec.", "example": "http://localhost:8080" } } }, { "type": "object", "required": [ "server_urls" ], "properties": { "server_urls": { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1, "maxLength": 4096 }, "description": "The server URLs. It should be configured if the server URLs are not defined in the OpenAPI spec.", "example": [ "http://localhost:8080", "http://localhost:8081" ] } } } ] } ] }, { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "desc": { "type": "string", "description": "Description." }, "api_desc": { "type": "string", "description": "API description." }, "api_count": { "type": "number", "format": "int32", "description": "API count.", "example": 10 } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } ] }, { "type": "object", "properties": { "subscription_status": { "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } } } ] } } } }, "ListAPIProductResponse": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of API products.", "items": { "description": "The API product with subscription status.", "allOf": [ { "description": "The API product.", "oneOf": [ { "title": "Gateway API Product", "type": "object", "allOf": [ { "type": "object", "required": [ "type", "name", "auth", "status", "subscription_auto_approval", "can_view_unsubscribed", "visibility" ], "properties": { "type": { "type": "string", "enum": [ "gateway" ], "default": "gateway" }, "name": { "example": "Weather Insights API", "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100 }, "logo": { "type": "string", "description": "The base64-encoded logo image of the API product." }, "desc": { "type": "string", "description": "The description of the API product.", "example": "The Weather Insights API provides real-time and historical weather data for any location worldwide." }, "labels": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^.+$", "minLength": 1, "maxLength": 65536 }, "description": "Key-value pairs of labels.", "example": { "version": "v2", "env": "prod" } }, "auth": { "type": "object", "description": "The authentication configuration of the API product.", "additionalProperties": false, "minProperties": 1, "example": { "key-auth": { "header": "apikey", "hide_credentials": false, "query": "apikey" } }, "properties": { "key-auth": { "type": "object", "additionalProperties": false, "description": "Key authentication configurations.", "properties": { "hide_credentials": { "type": "boolean", "default": false, "description": "If true, do not pass the header or query string with key to upstream services." }, "query": { "type": "string", "default": "apikey", "description": "The query string to get the key from. Lower priority than header." }, "header": { "type": "string", "default": "apikey", "description": "The header to get the key from." } } }, "basic-auth": { "type": "object", "additionalProperties": false, "description": "Basic authentication configurations.", "properties": { "hide_credentials": { "type": "boolean", "default": false, "description": "If true, do not pass the header or query string with key to upstream services." } } }, "dcr": { "type": "object", "additionalProperties": false, "description": "DCR authentication configurations.", "required": [ "dcr_provider_id" ], "properties": { "dcr_provider_id": { "description": "ID of the DCR provider.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" } } } } }, "status": { "type": "string", "description": "Status of the API product.", "enum": [ "draft", "published" ], "default": "draft" }, "subscription_auto_approval": { "type": "boolean", "default": false, "description": "If true, the subscription is automatically approved." }, "can_view_unsubscribed": { "type": "boolean", "description": "If true, developers can view the unsubscribed API.", "default": true }, "visibility": { "type": "string", "enum": [ "public", "logged_in" ], "default": "public", "description": "The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers." }, "raw_openapis": { "type": "array", "description": "An array of raw OpenAPI specifications. It is only returned when getting an API product.", "items": { "type": "string", "description": "The raw OpenAPI specification of the API product.", "example": "Raw OpenAPI spec" } }, "api_count": { "type": "number", "format": "int32", "description": "API count. It is only returned when listing API products.", "example": 10 } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] }, { "title": "External API Product", "type": "object", "allOf": [ { "allOf": [ { "type": "object", "required": [ "name", "type", "status", "visibility" ], "properties": { "type": { "type": "string", "description": "Type of API product.", "enum": [ "external" ], "default": "external" }, "name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "raw_openapis": { "type": "array", "description": "An array of raw OpenAPI specifications. It is only returned when getting an API product.", "items": { "type": "string", "description": "The raw OpenAPI specification of the API product.", "example": "Raw OpenAPI spec" } }, "status": { "type": "string", "description": "Status of the API product.", "enum": [ "draft", "published" ], "default": "draft" }, "visibility": { "type": "string", "enum": [ "public", "logged_in" ], "default": "public", "description": "The visibility of the API product in the API hub. `public` means the product is visible to all users and `logged_in` means the product is only visible to logged-in developers." } } }, { "anyOf": [ { "type": "object", "required": [ "server_url" ], "properties": { "server_url": { "deprecated": true, "type": "string", "minLength": 1, "maxLength": 4096, "description": "The server URL. It should be configured if the server URL is not defined in the OpenAPI spec.", "example": "http://localhost:8080" } } }, { "type": "object", "required": [ "server_urls" ], "properties": { "server_urls": { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1, "maxLength": 4096 }, "description": "The server URLs. It should be configured if the server URLs are not defined in the OpenAPI spec.", "example": [ "http://localhost:8080", "http://localhost:8081" ] } } } ] } ] }, { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "desc": { "type": "string", "description": "Description." }, "api_desc": { "type": "string", "description": "API description." }, "api_count": { "type": "number", "format": "int32", "description": "API count.", "example": 10 } } }, { "type": "object", "required": [ "id", "created_at", "updated_at" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "created_at": { "description": "The time when the object was created in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "description": "The time when the object was last updated in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } ] } ] }, { "type": "object", "properties": { "subscription_status": { "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } } } ] } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "ListDCRProviderResponse": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of DCR providers.", "items": { "type": "object", "required": [ "id", "name", "issuer" ], "properties": { "id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "The name of the Dynamic Client Registration (DCR) Provider." }, "provider_type": { "type": "string", "enum": [ "oidc", "http_bridge" ], "description": "The type of DCR provider." }, "issuer": { "type": "string", "description": "The issuer URL of the Authorization Server." } } } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "ListSubscriptionResponse": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of subscriptions.", "items": { "type": "object", "required": [ "id", "developer_id", "developer_name", "application_id", "application_name", "api_product_id", "api_product_name", "status" ], "properties": { "id": { "type": "string", "description": "The ID of the subscription." }, "developer_id": { "type": "string" }, "developer_name": { "type": "string" }, "subscribed_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "application_id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "application_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "api_product_id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "api_product_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "status": { "type": "string", "enum": [ "unsubscribed", "wait_for_approval", "subscribed" ] } } } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "DeveloperResponse": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "created_at", "updated_at" ], "properties": { "id": { "description": "Developer ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "Developer name.", "example": "dev one" }, "last_active_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "created_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } } } }, "ListDeveloperResponse": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of developers.", "items": { "type": "object", "required": [ "id", "name", "created_at", "updated_at" ], "properties": { "id": { "description": "Developer ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "name": { "type": "string", "description": "Developer name.", "example": "dev one" }, "last_active_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "created_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2025-01-01T00:00:00.000Z" } } } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "ListAPICallResponse": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "list", "total" ], "properties": { "list": { "type": "array", "description": "An array of API calls.", "items": { "type": "object", "required": [ "api_product_id", "api_product_name", "hour_timestamp", "api_calls" ], "properties": { "api_product_id": { "description": "The object ID.", "type": "string", "pattern": "^[a-zA-Z0-9-_.]+$", "minLength": 1, "maxLength": 256, "example": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101" }, "api_product_name": { "description": "The object name.", "type": "string", "minLength": 1, "maxLength": 100, "example": "us-west-rsc" }, "hour_timestamp": { "description": "The object timestamp.", "type": "integer", "minimum": 0, "example": 1742288230 }, "api_calls": { "type": "integer", "description": "The number of API calls." } } } }, "total": { "type": "integer", "minimum": 0, "example": 1, "description": "Total number of objects." } } } } } }, "ListLabelResponse": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "example": { "k8s/namespace": [ "api7-ingress-system", "default", "api7" ], "manager-by": [ "api7-ingress-controller", "apisix-ingress-controller" ] } } } } }, "SMTPServerSettingsStatusResponse": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "enable" ], "properties": { "enable": { "type": "boolean", "description": "Enable SMTP Server." } } } } } }, "PortalPublicAccessResponse": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "portal_public_access" ], "properties": { "portal_public_access": { "type": "boolean", "description": "If true, allow public access to the developer portal." } } } } } } } } }