API Product

List all API products

Changed on
get/api/api_products

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

pageinteger

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.

page_sizeinteger

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.

direction'asc' | 'desc'

Order to list the resources by. The sorting index follows the configuration of order_by.

order_by'created_at' | 'updated_at'

Field used to order resources, either created_at or updated_at.

Index to order resources by.

searchstring

Condition to search resources by.

subscription_status'unsubscribed' | 'wait_for_approval' | 'subscribed'
application_idstring

The object ID.

Example:bd58fce2-b6cc-4d2d-a53c-6ce11b19c101

Response

totalinteger required

Total number of objects.

Example response

{
  "list": [
    {
      "name": "us-west-rsc",
      "desc": "The Weather Insights API provides real-time and historical weather data for any location worldwide.",
      "labels": {
        "version": "v2",
        "env": "prod"
      },
      "auth": {
        "key-auth": {
          "header": "apikey",
          "hide_credentials": false,
          "query": "apikey"
        }
      },
      "raw_openapis": [
        "Raw OpenAPI spec"
      ],
      "api_count": 10,
      "id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
      "created_at": "2025-01-01T00:00:00.000Z",
      "updated_at": "2025-01-01T00:00:00.000Z"
    }
  ],
  "total": 1
}

Changes

  • 12f96ac28b19Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API

  • 53b809c2d9b1Revision changes
    • breaking

      for the query request parameter page, the format changed from int64 to int32

    • breaking

      for the query request parameter page_size, the format changed from int64 to int32

    • breaking

      the //////// response's property format changed from int64 to int32 for status

    • info

      added the optional property //////// to the response with the status

    • info

      the response's property default value 400 was removed for the status

    • info

      the response's property default value 401 was removed for the status