Credential

List all Credentials

Changed on
get/api/credentials

Request

  • The document declares no server URL.
  • Auth: HTTP bearer and API key in header X-Portal-Developer-ID

Query parameters

application_idID[] 
[
  "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101"
]
auth_method'key-auth' | 'basic-auth' | 'oauth'

The authentication method of the developer credential.

plugin_namestring

The object name.

Example:us-west-rsc

The plugin name of the application credential, recommended to use auth_method instead.

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' | 'name'

Index to order credentials by.

searchstring

Condition to search resources by.

labelsstring
Example:labels%5Bversion%5D=v2

Label(s) to filter resources by. The format is labels[key]=value and should be URL-encoded.

Response

totalinteger required

Total number of objects.

Example response

{
  "list": [
    {
      "application_id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
      "application_name": "us-west-rsc",
      "desc": "Object description.",
      "labels": {
        "version": "v2",
        "env": "prod"
      },
      "name": "us-west-rsc",
      "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 AND DeveloperIDHeader was added to the API

  • 492647764121Revision changes
    • info

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

    • info

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

    • info

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