Skip to main content
Documentation Powered by Redocly

API7 Cloud OpenAPI Specification (0.11.0)

Download OpenAPI specification:Download

The OpenAPI specification for API7 Cloud APIs. All APIs are built around Rest. They accept JSON-encoded request body (if necessary) and return JSON-encoded response. The actual API response payload is decorated with some metadata fields:

{
  "status": {
    "code": <ERROR CODE>,
    "message": "<ERROR MESSAGE>"
  },
  "error": "ERROR DETAILS",
  "payload": <SPECIFIC API RESPONSE>
}

The status and error fields indicate the error code and error message for this API call. payload field contains the specific API response and should be decoded according to the given schema.

Authentication

token

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Organizations

Create Organization

Authorizations:
token
    Request Body schema: application/json
    name
    required
    string [ 1 .. 32 ] characters \S+

    Responses

    Request samples

    Content type
    application/json
    {
    • "name": "string"
    }

    Response samples

    Content type
    application/json
    {
    • "error": "string",
    • "status": {
      },
    • "payload": {
      }
    }

    Get Organization Information

    Authorizations:
    token
      path Parameters
      id
      required
      string non-empty ^[1-9][0-9]*$

      ID is the organization id

      Responses

      Response samples

      Content type
      application/json
      {
      • "error": "string",
      • "status": {
        },
      • "payload": {
        }
      }

      Create a new subscription

      Authorizations:
      token
        path Parameters
        id
        required
        string non-empty ^[1-9][0-9]*$

        ID is the organization id

        Request Body schema: application/json
        plan
        required
        string non-empty

        Responses

        Request samples

        Content type
        application/json
        {
        • "plan": "string"
        }

        Response samples

        Content type
        application/json
        {
        • "error": "string",
        • "status": {
          },
        • "payload": {}
        }

        Get Upcoming Invoice

        Authorizations:
        token
          path Parameters
          id
          required
          string non-empty ^[1-9][0-9]*$

          ID is the organization id

          Responses

          Response samples

          Content type
          application/json
          {
          • "error": "string",
          • "status": {
            },
          • "payload": {
            }
          }

          Redirect to stripe customer portal

          Authorizations:
          token
            path Parameters
            id
            required
            string non-empty ^[1-9][0-9]*$

            ID is the organization id

            Responses

            Response samples

            Content type
            application/json
            {
            • "error": "string",
            • "status": {
              }
            }

            Initialize Organization

            Authorizations:
            token
              Request Body schema: application/json
              name
              required
              string [ 1 .. 32 ] characters \S+

              Responses

              Request samples

              Content type
              application/json
              {
              • "name": "string"
              }

              Response samples

              Content type
              application/json
              {
              • "error": "string",
              • "status": {
                }
              }

              Control Planes

              List Control Planes

              Authorizations:
              token
                path Parameters
                id
                required
                string non-empty ^[1-9][0-9]*$

                ID is the organization id

                query Parameters
                order_by
                string
                Default: "updated_at"
                Enum: "created_at" "updated_at"
                direction
                string
                Default: "DESC"
                Enum: "ASC" "DESC"

                Direction should be ASC or DESC (case-insensitive). Default value is DESC.

                page_size
                integer <int64> >= 1
                Default: 10

                PageSize is the page size. Must greater than 0.

                page
                integer <int64> >= 1
                Default: 1

                Page is the page number, starting from 1.

                Responses

                Response samples

                Content type
                application/json
                {
                • "error": "string",
                • "status": {
                  },
                • "payload": {
                  }
                }

                Create Control Plane

                Authorizations:
                token
                  path Parameters
                  id
                  required
                  string non-empty ^[1-9][0-9]*$

                  ID is the organization id

                  Request Body schema: application/json
                  object

                  Responses

                  Request samples

                  Content type
                  application/json
                  { }

                  Response samples

                  Content type
                  application/json
                  {
                  • "error": "string",
                  • "status": {
                    },
                  • "payload": {
                    }
                  }

                  Get Control Plane Details

                  Authorizations:
                  token
                    path Parameters
                    id
                    required
                    string non-empty ^[1-9][0-9]*$

                    ID is the organization id

                    control_plane_id
                    required
                    string non-empty ^[1-9][0-9]*$

                    ControlPlaneID is the control plane id

                    Responses

                    Response samples

                    Content type
                    application/json
                    {
                    • "error": "string",
                    • "status": {
                      },
                    • "payload": {
                      }
                    }

                    Update Control Plane

                    Authorizations:
                    token
                      path Parameters
                      id
                      required
                      string non-empty ^[1-9][0-9]*$

                      ID is the organization id

                      control_plane_id
                      required
                      string non-empty ^[1-9][0-9]*$

                      ControlPlaneID is the control plane id

                      Request Body schema: application/json
                      object
                      object
                      object
                      object

                      Responses

                      Request samples

                      Content type
                      application/json
                      {
                      • "client_settings": {
                        },
                      • "observability_settings": {
                        },
                      • "api_proxy_settings": {
                        },
                      • "service_discovery_settings": {
                        }
                      }

                      Response samples

                      Content type
                      application/json
                      {
                      • "error": "string",
                      • "status": {
                        }
                      }

                      Applications

                      List Applications

                      Authorizations:
                      token
                        path Parameters
                        control_plane_id
                        required
                        string non-empty ^[1-9][0-9]*$

                        ControlPlaneID is the control plane id

                        query Parameters
                        order_by
                        string
                        Enum: "created_at" "updated_at"
                        direction
                        string
                        Default: "DESC"
                        Enum: "ASC" "DESC"

                        Direction should be ASC or DESC (case-insensitive). Default value is DESC.

                        page_size
                        integer <int64> >= 1
                        Default: 10

                        PageSize is the page size. Must greater than 0.

                        page
                        integer <int64> >= 1
                        Default: 1

                        Page is the page number, starting from 1.

                        search
                        string

                        search is used to filter the result

                        labels
                        Array of strings [ 0 .. 32 ] items [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                        Labels are used to filter the result

                        Responses

                        Response samples

                        Content type
                        application/json
                        {
                        • "error": "string",
                        • "status": {
                          },
                        • "payload": {
                          }
                        }

                        Create Application

                        Authorizations:
                        token
                          path Parameters
                          control_plane_id
                          required
                          string non-empty ^[1-9][0-9]*$

                          ControlPlaneID is the control plane id

                          Request Body schema: application/json
                          description
                          string <= 256 characters
                          hosts
                          required
                          Array of strings non-empty unique
                          name
                          required
                          string [ 1 .. 64 ] characters
                          path_prefix
                          required
                          string [ 1 .. 4096 ] characters ^/

                          The listening path prefix for this application

                          object

                          Policies contains a collect of polices like CORS.

                          protocol
                          string
                          Enum: "HTTP" "HTTPS"

                          The API Protocol definition

                          protocols
                          Array of strings [ 1 .. 2 ] items unique
                          Items Enum: "HTTP" "HTTPS"
                          required
                          Array of objects [ 1 .. 10 ] items unique [ items ]

                          Upstream settings for the Application

                          default_upstream_version
                          string [ 0 .. 64 ] characters
                          Default: "default"
                          labels
                          Array of strings [ 0 .. 32 ] items unique [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                          Labels are used for resources classification and indexing

                          Responses

                          Request samples

                          Content type
                          application/json
                          {
                          • "description": "string",
                          • "hosts": [
                            ],
                          • "name": "string",
                          • "path_prefix": "string",
                          • "policies": {
                            },
                          • "protocol": "HTTP",
                          • "protocols": [
                            ],
                          • "upstreams": [
                            ],
                          • "default_upstream_version": "default",
                          • "labels": [
                            ]
                          }

                          Response samples

                          Content type
                          application/json
                          {
                          • "error": "string",
                          • "status": {
                            },
                          • "payload": {
                            }
                          }

                          Get Application Details

                          Authorizations:
                          token
                            path Parameters
                            control_plane_id
                            required
                            string non-empty ^[1-9][0-9]*$

                            ControlPlaneID is the control plane id

                            app_id
                            required
                            string^[1-9][0-9]*$

                            The id of the pet to retrieve

                            Responses

                            Response samples

                            Content type
                            application/json
                            {
                            • "error": "string",
                            • "status": {
                              },
                            • "payload": {
                              }
                            }

                            Update Application

                            Authorizations:
                            token
                              path Parameters
                              control_plane_id
                              required
                              string non-empty ^[1-9][0-9]*$

                              ControlPlaneID is the control plane id

                              app_id
                              required
                              string^[1-9][0-9]*$

                              The id of the pet to retrieve

                              Request Body schema: application/json
                              description
                              string <= 256 characters
                              hosts
                              required
                              Array of strings non-empty unique
                              name
                              required
                              string [ 1 .. 64 ] characters
                              path_prefix
                              required
                              string [ 1 .. 4096 ] characters ^/

                              The listening path prefix for this application

                              object

                              Policies contains a collect of polices like CORS.

                              protocol
                              string
                              Enum: "HTTP" "HTTPS"

                              The API Protocol definition

                              protocols
                              Array of strings [ 1 .. 2 ] items unique
                              Items Enum: "HTTP" "HTTPS"
                              required
                              Array of objects [ 1 .. 10 ] items unique [ items ]

                              Upstream settings for the Application

                              default_upstream_version
                              string [ 0 .. 64 ] characters
                              Default: "default"
                              labels
                              Array of strings [ 0 .. 32 ] items unique [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                              Labels are used for resources classification and indexing

                              Responses

                              Request samples

                              Content type
                              application/json
                              {
                              • "description": "string",
                              • "hosts": [
                                ],
                              • "name": "string",
                              • "path_prefix": "string",
                              • "policies": {
                                },
                              • "protocol": "HTTP",
                              • "protocols": [
                                ],
                              • "upstreams": [
                                ],
                              • "default_upstream_version": "default",
                              • "labels": [
                                ]
                              }

                              Response samples

                              Content type
                              application/json
                              {
                              • "error": "string",
                              • "status": {
                                },
                              • "payload": {
                                }
                              }

                              Patch Application

                              Authorizations:
                              token
                                path Parameters
                                control_plane_id
                                required
                                string non-empty ^[1-9][0-9]*$

                                ControlPlaneID is the control plane id

                                app_id
                                required
                                string^[1-9][0-9]*$

                                The id of the pet to retrieve

                                Request Body schema: application/json
                                description
                                string <= 256 characters
                                hosts
                                Array of strings non-empty unique
                                name
                                string [ 1 .. 64 ] characters
                                path_prefix
                                string [ 1 .. 4096 ] characters ^/

                                The listening path prefix for this application

                                object

                                Policies contains a collect of polices like CORS.

                                protocol
                                string
                                Enum: "HTTP" "HTTPS"

                                The API Protocol definition

                                protocols
                                Array of strings [ 1 .. 2 ] items unique
                                Items Enum: "HTTP" "HTTPS"
                                Array of objects [ 1 .. 10 ] items unique [ items ]

                                Upstream settings for the Application

                                default_upstream_version
                                string [ 0 .. 64 ] characters
                                Default: "default"
                                labels
                                Array of strings [ 0 .. 32 ] items unique [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                                Labels are used for resources classification and indexing

                                Responses

                                Request samples

                                Content type
                                application/json
                                {
                                • "description": "string",
                                • "hosts": [
                                  ],
                                • "name": "string",
                                • "path_prefix": "string",
                                • "policies": {
                                  },
                                • "protocol": "HTTP",
                                • "protocols": [
                                  ],
                                • "upstreams": [
                                  ],
                                • "default_upstream_version": "default",
                                • "labels": [
                                  ]
                                }

                                Response samples

                                Content type
                                application/json
                                {
                                • "error": "string",
                                • "status": {
                                  },
                                • "payload": {
                                  }
                                }

                                Delete Application

                                Authorizations:
                                token
                                  path Parameters
                                  control_plane_id
                                  required
                                  string non-empty ^[1-9][0-9]*$

                                  ControlPlaneID is the control plane id

                                  app_id
                                  required
                                  string^[1-9][0-9]*$

                                  The id of the pet to retrieve

                                  Responses

                                  Response samples

                                  Content type
                                  application/json
                                  {
                                  • "error": "string",
                                  • "status": {
                                    }
                                  }

                                  Create Application

                                  Authorizations:
                                  token
                                    path Parameters
                                    control_plane_id
                                    required
                                    string non-empty ^[1-9][0-9]*$

                                    ControlPlaneID is the control plane id

                                    Request Body schema: application/json
                                    openapi
                                    required
                                    string

                                    Responses

                                    Request samples

                                    Content type
                                    application/json
                                    {
                                    • "openapi": "string"
                                    }

                                    Response samples

                                    Content type
                                    application/json
                                    {
                                    • "error": "string",
                                    • "status": {
                                      }
                                    }

                                    APIs

                                    List APIs

                                    Authorizations:
                                    token
                                      path Parameters
                                      app_id
                                      required
                                      string^[1-9][0-9]*$

                                      The id of the pet to retrieve

                                      query Parameters
                                      order_by
                                      string
                                      Default: "updated_at"
                                      Enum: "created_at" "updated_at"
                                      direction
                                      string
                                      Default: "DESC"
                                      Enum: "ASC" "DESC"

                                      Direction should be ASC or DESC (case-insensitive). Default value is DESC.

                                      page_size
                                      integer <int64> >= 1
                                      Default: 10

                                      PageSize is the page size. Must greater than 0.

                                      page
                                      integer <int64> >= 1
                                      Default: 1

                                      Page is the page number, starting from 1.

                                      search
                                      string

                                      search is used to filter the result

                                      labels
                                      Array of strings [ 0 .. 32 ] items [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                                      Labels are used to filter the result

                                      Responses

                                      Response samples

                                      Content type
                                      application/json
                                      {
                                      • "error": "string",
                                      • "status": {
                                        },
                                      • "payload": {
                                        }
                                      }

                                      Create API

                                      Authorizations:
                                      token
                                        path Parameters
                                        app_id
                                        required
                                        string^[1-9][0-9]*$

                                        The id of the pet to retrieve

                                        Request Body schema: application/json
                                        active
                                        integer <int64>
                                        Enum: 0 1

                                        Active is the status of the API 0 stands for active 1 stands for inactive

                                        description
                                        string <= 256 characters
                                        Array of strings or Array of strings

                                        Allowed HTTP methods to access this API, if absent, all HTTP methods are allowed

                                        name
                                        required
                                        string [ 1 .. 64 ] characters
                                        required
                                        Array of objects [ 1 .. 64 ] items [ items ]

                                        Which URI paths can be matched to this API

                                        object

                                        Policies contains a collect of polices like CORS.

                                        strip_path_prefix
                                        boolean

                                        Whether to strip the path prefix (defined in the Application)

                                        labels
                                        Array of strings [ 0 .. 32 ] items unique [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                                        Labels are used for resources classification and indexing

                                        type
                                        string
                                        Default: "Rest"
                                        Enum: "Rest" "WebSocket"

                                        Type is the type of the API Rest means this is a Rest API. WebSocket means this is a WebSocket API.

                                        Responses

                                        Request samples

                                        Content type
                                        application/json
                                        {
                                        • "active": 0,
                                        • "description": "string",
                                        • "methods": [
                                          ],
                                        • "name": "string",
                                        • "paths": [
                                          ],
                                        • "policies": {
                                          },
                                        • "strip_path_prefix": true,
                                        • "labels": [
                                          ],
                                        • "type": "Rest"
                                        }

                                        Response samples

                                        Content type
                                        application/json
                                        {
                                        • "error": "string",
                                        • "status": {
                                          }
                                        }

                                        Delete All APIs

                                        Authorizations:
                                        token
                                          path Parameters
                                          app_id
                                          required
                                          string^[1-9][0-9]*$

                                          The id of the pet to retrieve

                                          Responses

                                          Response samples

                                          Content type
                                          application/json
                                          {
                                          • "error": "string",
                                          • "status": {
                                            }
                                          }

                                          Get API Details

                                          Authorizations:
                                          token
                                            path Parameters
                                            app_id
                                            required
                                            string^[1-9][0-9]*$

                                            The id of the pet to retrieve

                                            api_id
                                            required
                                            string^[1-9][0-9]*$

                                            APIID is the API id

                                            Responses

                                            Response samples

                                            Content type
                                            application/json
                                            {
                                            • "error": "string",
                                            • "status": {
                                              },
                                            • "payload": {
                                              }
                                            }

                                            Update API

                                            Authorizations:
                                            token
                                              path Parameters
                                              app_id
                                              required
                                              string^[1-9][0-9]*$

                                              The id of the pet to retrieve

                                              api_id
                                              required
                                              string^[1-9][0-9]*$

                                              APIID is the API id

                                              Request Body schema: application/json
                                              active
                                              integer <int64>
                                              Enum: 0 1

                                              Active is the status of the API 0 stands for active 1 stands for inactive

                                              description
                                              string <= 256 characters
                                              Array of strings or Array of strings

                                              Allowed HTTP methods to access this API, if absent, all HTTP methods are allowed

                                              name
                                              required
                                              string [ 1 .. 64 ] characters
                                              required
                                              Array of objects [ 1 .. 64 ] items [ items ]

                                              Which URI paths can be matched to this API

                                              object

                                              Policies contains a collect of polices like CORS.

                                              strip_path_prefix
                                              boolean

                                              Whether to strip the path prefix (defined in the Application)

                                              labels
                                              Array of strings [ 0 .. 32 ] items unique [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                                              Labels are used for resources classification and indexing

                                              type
                                              string
                                              Default: "Rest"
                                              Enum: "Rest" "WebSocket"

                                              Type is the type of the API Rest means this is a Rest API. WebSocket means this is a WebSocket API.

                                              Responses

                                              Request samples

                                              Content type
                                              application/json
                                              {
                                              • "active": 0,
                                              • "description": "string",
                                              • "methods": [
                                                ],
                                              • "name": "string",
                                              • "paths": [
                                                ],
                                              • "policies": {
                                                },
                                              • "strip_path_prefix": true,
                                              • "labels": [
                                                ],
                                              • "type": "Rest"
                                              }

                                              Response samples

                                              Content type
                                              application/json
                                              {
                                              • "error": "string",
                                              • "status": {
                                                },
                                              • "payload": {
                                                }
                                              }

                                              Patch API

                                              Authorizations:
                                              token
                                                path Parameters
                                                app_id
                                                required
                                                string^[1-9][0-9]*$

                                                The id of the pet to retrieve

                                                api_id
                                                required
                                                string^[1-9][0-9]*$

                                                APIID is the API id

                                                Request Body schema: application/json
                                                active
                                                integer <int64>
                                                Enum: 0 1

                                                Active is the status of the API 0 stands for active 1 stands for inactive

                                                description
                                                string <= 256 characters
                                                Array of strings or Array of strings

                                                Allowed HTTP methods to access this API, if absent, all HTTP methods are allowed

                                                name
                                                string [ 1 .. 64 ] characters
                                                Array of objects [ 1 .. 64 ] items [ items ]

                                                Which URI paths can be matched to this API

                                                object

                                                Policies contains a collect of polices like CORS.

                                                strip_path_prefix
                                                boolean

                                                Whether to strip the path prefix (defined in the Application)

                                                labels
                                                Array of strings [ 0 .. 32 ] items unique [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                                                Labels are used for resources classification and indexing

                                                type
                                                string
                                                Default: "Rest"
                                                Enum: "Rest" "WebSocket"

                                                Type is the type of the API Rest means this is a Rest API. WebSocket means this is a WebSocket API.

                                                Responses

                                                Request samples

                                                Content type
                                                application/json
                                                {
                                                • "active": 0,
                                                • "description": "string",
                                                • "methods": [
                                                  ],
                                                • "name": "string",
                                                • "paths": [
                                                  ],
                                                • "policies": {
                                                  },
                                                • "strip_path_prefix": true,
                                                • "labels": [
                                                  ],
                                                • "type": "Rest"
                                                }

                                                Response samples

                                                Content type
                                                application/json
                                                {
                                                • "error": "string",
                                                • "status": {
                                                  },
                                                • "payload": {
                                                  }
                                                }

                                                Delete API

                                                Authorizations:
                                                token
                                                  path Parameters
                                                  app_id
                                                  required
                                                  string^[1-9][0-9]*$

                                                  The id of the pet to retrieve

                                                  api_id
                                                  required
                                                  string^[1-9][0-9]*$

                                                  APIID is the API id

                                                  Responses

                                                  Response samples

                                                  Content type
                                                  application/json
                                                  {
                                                  • "error": "string",
                                                  • "status": {
                                                    }
                                                  }

                                                  Consumers

                                                  List Consumers

                                                  Authorizations:
                                                  token
                                                    path Parameters
                                                    control_plane_id
                                                    required
                                                    string non-empty ^[1-9][0-9]*$

                                                    ControlPlaneID is the control plane id

                                                    query Parameters
                                                    direction
                                                    string
                                                    Default: "DESC"
                                                    Enum: "ASC" "DESC"

                                                    Direction should be ASC or DESC (case-insensitive). Default value is DESC.

                                                    page_size
                                                    integer <int64> >= 1
                                                    Default: 10

                                                    PageSize is the page size. Must greater than 0.

                                                    page
                                                    integer <int64> >= 1
                                                    Default: 1

                                                    Page is the page number, starting from 1.

                                                    order_by
                                                    string
                                                    Default: "updated_at"
                                                    Enum: "created_at" "updated_at"
                                                    search
                                                    string

                                                    search is used to filter the result

                                                    labels
                                                    Array of strings [ 0 .. 32 ] items [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                                                    Labels are used to filter the result

                                                    Responses

                                                    Response samples

                                                    Content type
                                                    application/json
                                                    {
                                                    • "error": "string",
                                                    • "status": {
                                                      },
                                                    • "payload": {
                                                      }
                                                    }

                                                    Create Consumer

                                                    Authorizations:
                                                    token
                                                      path Parameters
                                                      control_plane_id
                                                      required
                                                      string non-empty ^[1-9][0-9]*$

                                                      ControlPlaneID is the control plane id

                                                      Request Body schema: application/json
                                                      description
                                                      string <= 256 characters

                                                      Description for this consumer.

                                                      name
                                                      required
                                                      string [ 1 .. 100 ] characters ^[a-zA-Z0-9_]+$

                                                      Name of the consumer, should be unique among all applications in the same control plane.

                                                      object or null

                                                      ConsumerCredentials contains a collect of policies can be configured on the consumer.

                                                      labels
                                                      Array of strings [ 0 .. 32 ] items unique [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                                                      Labels are used for resources classification and indexing

                                                      Responses

                                                      Request samples

                                                      Content type
                                                      application/json
                                                      {
                                                      • "description": "jack is the most important API consumer.",
                                                      • "name": "jack",
                                                      • "credentials": {
                                                        },
                                                      • "labels": [
                                                        ]
                                                      }

                                                      Response samples

                                                      Content type
                                                      application/json
                                                      {
                                                      • "error": "string",
                                                      • "status": {
                                                        },
                                                      • "payload": {
                                                        }
                                                      }

                                                      Get Consumer Details

                                                      Authorizations:
                                                      token
                                                        path Parameters
                                                        control_plane_id
                                                        required
                                                        string non-empty ^[1-9][0-9]*$

                                                        ControlPlaneID is the control plane id

                                                        consumer_id
                                                        required
                                                        string non-empty ^[1-9][0-9]*$

                                                        ConsumerId is the consumer id

                                                        Responses

                                                        Response samples

                                                        Content type
                                                        application/json
                                                        {
                                                        • "error": "string",
                                                        • "status": {
                                                          },
                                                        • "payload": {
                                                          }
                                                        }

                                                        Update Consumer

                                                        Authorizations:
                                                        token
                                                          path Parameters
                                                          control_plane_id
                                                          required
                                                          string non-empty ^[1-9][0-9]*$

                                                          ControlPlaneID is the control plane id

                                                          consumer_id
                                                          required
                                                          string non-empty ^[1-9][0-9]*$

                                                          ConsumerId is the consumer id

                                                          Request Body schema: application/json
                                                          description
                                                          string <= 256 characters

                                                          Description for this consumer.

                                                          name
                                                          required
                                                          string [ 1 .. 100 ] characters ^[a-zA-Z0-9_]+$

                                                          Name of the consumer, should be unique among all applications in the same control plane.

                                                          object or null

                                                          ConsumerCredentials contains a collect of policies can be configured on the consumer.

                                                          labels
                                                          Array of strings [ 0 .. 32 ] items unique [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                                                          Labels are used for resources classification and indexing

                                                          Responses

                                                          Request samples

                                                          Content type
                                                          application/json
                                                          {
                                                          • "description": "jack is the most important API consumer.",
                                                          • "name": "jack",
                                                          • "credentials": {
                                                            },
                                                          • "labels": [
                                                            ]
                                                          }

                                                          Response samples

                                                          Content type
                                                          application/json
                                                          {
                                                          • "error": "string",
                                                          • "status": {
                                                            }
                                                          }

                                                          Patch Consumer

                                                          Authorizations:
                                                          token
                                                            path Parameters
                                                            control_plane_id
                                                            required
                                                            string non-empty ^[1-9][0-9]*$

                                                            ControlPlaneID is the control plane id

                                                            consumer_id
                                                            required
                                                            string non-empty ^[1-9][0-9]*$

                                                            ConsumerId is the consumer id

                                                            Request Body schema: application/json
                                                            description
                                                            string <= 256 characters

                                                            Description for this consumer.

                                                            name
                                                            string [ 1 .. 100 ] characters ^[a-zA-Z0-9_]+$

                                                            Name of the consumer, should be unique among all applications in the same control plane.

                                                            object or null

                                                            ConsumerCredentials contains a collect of policies can be configured on the consumer.

                                                            labels
                                                            Array of strings [ 0 .. 32 ] items unique [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                                                            Labels are used for resources classification and indexing

                                                            Responses

                                                            Request samples

                                                            Content type
                                                            application/json
                                                            {
                                                            • "description": "jack is the most important API consumer.",
                                                            • "name": "jack",
                                                            • "credentials": {
                                                              },
                                                            • "labels": [
                                                              ]
                                                            }

                                                            Response samples

                                                            Content type
                                                            application/json
                                                            {
                                                            • "error": "string",
                                                            • "status": {
                                                              }
                                                            }

                                                            Delete Consumer

                                                            Authorizations:
                                                            token
                                                              path Parameters
                                                              control_plane_id
                                                              required
                                                              string non-empty ^[1-9][0-9]*$

                                                              ControlPlaneID is the control plane id

                                                              consumer_id
                                                              required
                                                              string non-empty ^[1-9][0-9]*$

                                                              ConsumerId is the consumer id

                                                              Responses

                                                              Response samples

                                                              Content type
                                                              application/json
                                                              {
                                                              • "error": "string",
                                                              • "status": {
                                                                }
                                                              }

                                                              Create an JSON Web Token

                                                              Authorizations:
                                                              token
                                                                path Parameters
                                                                control_plane_id
                                                                required
                                                                string non-empty ^[1-9][0-9]*$

                                                                ControlPlaneID is the control plane id

                                                                consumer_id
                                                                required
                                                                string non-empty ^[1-9][0-9]*$

                                                                ConsumerId is the consumer id

                                                                Request Body schema: application/json
                                                                ttl
                                                                integer <int64> >= 1
                                                                Default: 86400

                                                                TTL is the time to live of token.

                                                                custom_payload
                                                                object

                                                                CustomPayload contains some custom key-value fields. These fields will also be kept in the JSON Web Token.

                                                                Responses

                                                                Request samples

                                                                Content type
                                                                application/json
                                                                {
                                                                • "ttl": 86400,
                                                                • "custom_payload": { }
                                                                }

                                                                Response samples

                                                                Content type
                                                                application/json
                                                                {
                                                                • "error": "string",
                                                                • "status": {
                                                                  }
                                                                }

                                                                Certificates

                                                                List Certificates

                                                                Authorizations:
                                                                token
                                                                  path Parameters
                                                                  control_plane_id
                                                                  required
                                                                  string non-empty ^[1-9][0-9]*$

                                                                  ControlPlaneID is the control plane id

                                                                  query Parameters
                                                                  direction
                                                                  string
                                                                  Default: "DESC"
                                                                  Enum: "ASC" "DESC"

                                                                  Direction should be ASC or DESC (case-insensitive). Default value is DESC.

                                                                  page_size
                                                                  integer <int64> >= 1
                                                                  Default: 10

                                                                  PageSize is the page size. Must greater than 0.

                                                                  page
                                                                  integer <int64> >= 1
                                                                  Default: 1

                                                                  Page is the page number, starting from 1.

                                                                  order_by
                                                                  string
                                                                  Default: "updated_at"
                                                                  Enum: "expiry_time" "created_at" "updated_at"
                                                                  labels
                                                                  Array of strings [ 0 .. 32 ] items [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                                                                  Labels are used to filter the result

                                                                  Responses

                                                                  Response samples

                                                                  Content type
                                                                  application/json
                                                                  {
                                                                  • "error": "string",
                                                                  • "status": {
                                                                    },
                                                                  • "payload": {
                                                                    }
                                                                  }

                                                                  Create Certificate

                                                                  Authorizations:
                                                                  token
                                                                    path Parameters
                                                                    control_plane_id
                                                                    required
                                                                    string non-empty ^[1-9][0-9]*$

                                                                    ControlPlaneID is the control plane id

                                                                    Request Body schema: application/json
                                                                    certificate
                                                                    required
                                                                    string [ 128 .. 65536 ] characters

                                                                    The certificate in PEM format.

                                                                    private_key
                                                                    required
                                                                    string [ 128 .. 65536 ] characters

                                                                    The private key for the corresponding certificate in PEM format.

                                                                    client_ca_certificate
                                                                    string [ 128 .. 65536 ] characters

                                                                    The client CA certificate in PEM format.

                                                                    labels
                                                                    Array of strings [ 0 .. 32 ] items unique [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                                                                    Labels are used for resources classification and indexing

                                                                    Responses

                                                                    Request samples

                                                                    Content type
                                                                    application/json
                                                                    {
                                                                    • "certificate": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringst",
                                                                    • "private_key": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringst",
                                                                    • "client_ca_certificate": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringst",
                                                                    • "labels": [
                                                                      ]
                                                                    }

                                                                    Response samples

                                                                    Content type
                                                                    application/json
                                                                    {
                                                                    • "error": "string",
                                                                    • "status": {
                                                                      },
                                                                    • "payload": {
                                                                      }
                                                                    }

                                                                    Get Certificate Details

                                                                    Authorizations:
                                                                    token
                                                                      path Parameters
                                                                      control_plane_id
                                                                      required
                                                                      string non-empty ^[1-9][0-9]*$

                                                                      ControlPlaneID is the control plane id

                                                                      certificate_id
                                                                      required
                                                                      string^[1-9][0-9]*$

                                                                      CertificateId is the certificate id

                                                                      Responses

                                                                      Response samples

                                                                      Content type
                                                                      application/json
                                                                      {
                                                                      • "error": "string",
                                                                      • "status": {
                                                                        },
                                                                      • "payload": {
                                                                        }
                                                                      }

                                                                      Update Certificate

                                                                      Authorizations:
                                                                      token
                                                                        path Parameters
                                                                        control_plane_id
                                                                        required
                                                                        string non-empty ^[1-9][0-9]*$

                                                                        ControlPlaneID is the control plane id

                                                                        certificate_id
                                                                        required
                                                                        string^[1-9][0-9]*$

                                                                        CertificateId is the certificate id

                                                                        Request Body schema: application/json
                                                                        certificate
                                                                        required
                                                                        string [ 128 .. 65536 ] characters

                                                                        The certificate in PEM format.

                                                                        private_key
                                                                        required
                                                                        string [ 128 .. 65536 ] characters

                                                                        The private key for the corresponding certificate in PEM format.

                                                                        client_ca_certificate
                                                                        string [ 128 .. 65536 ] characters

                                                                        The client CA certificate in PEM format.

                                                                        labels
                                                                        Array of strings [ 0 .. 32 ] items unique [ items [ 1 .. 32 ] characters ^[0-9a-zA-Z-_]+$ ]

                                                                        Labels are used for resources classification and indexing

                                                                        Responses

                                                                        Request samples

                                                                        Content type
                                                                        application/json
                                                                        {
                                                                        • "certificate": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringst",
                                                                        • "private_key": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringst",
                                                                        • "client_ca_certificate": "stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringst",
                                                                        • "labels": [
                                                                          ]
                                                                        }

                                                                        Response samples

                                                                        Content type
                                                                        application/json
                                                                        {
                                                                        • "error": "string",
                                                                        • "status": {
                                                                          },
                                                                        • "payload": {
                                                                          }
                                                                        }

                                                                        deleteCertificate

                                                                        Delete Certificate

                                                                        Authorizations:
                                                                        token
                                                                          path Parameters
                                                                          control_plane_id
                                                                          required
                                                                          string non-empty ^[1-9][0-9]*$

                                                                          ControlPlaneID is the control plane id

                                                                          certificate_id
                                                                          required
                                                                          string^[1-9][0-9]*$

                                                                          CertificateId is the certificate id

                                                                          Responses

                                                                          Response samples

                                                                          Content type
                                                                          application/json
                                                                          {
                                                                          • "error": "string",
                                                                          • "status": {
                                                                            }
                                                                          }

                                                                          Members

                                                                          List Members

                                                                          Authorizations:
                                                                          token
                                                                            path Parameters
                                                                            id
                                                                            required
                                                                            string non-empty ^[1-9][0-9]*$

                                                                            ID is the organization id

                                                                            query Parameters
                                                                            direction
                                                                            string
                                                                            Default: "DESC"
                                                                            Enum: "ASC" "DESC"

                                                                            Direction should be ASC or DESC (case-insensitive). Default value is DESC.

                                                                            page_size
                                                                            integer <int64> >= 1
                                                                            Default: 10

                                                                            PageSize is the page size. Must greater than 0.

                                                                            page
                                                                            integer <int64> >= 1
                                                                            Default: 1

                                                                            Page is the page number, starting from 1.

                                                                            order_by
                                                                            string
                                                                            Default: "updated_at"
                                                                            Enum: "id" "org_id" "role" "user_id" "created_at" "updated_at"

                                                                            Responses

                                                                            Response samples

                                                                            Content type
                                                                            application/json
                                                                            {
                                                                            • "error": "string",
                                                                            • "status": {
                                                                              },
                                                                            • "payload": {
                                                                              }
                                                                            }

                                                                            Create Member

                                                                            Authorizations:
                                                                            token
                                                                              path Parameters
                                                                              id
                                                                              required
                                                                              string non-empty ^[1-9][0-9]*$

                                                                              ID is the organization id

                                                                              Request Body schema: application/json
                                                                              email
                                                                              required
                                                                              string <email>

                                                                              Email is the email address of the member

                                                                              role_id
                                                                              required
                                                                              string^[1-9][0-9]*$

                                                                              Role ID is the role id of the member

                                                                              Responses

                                                                              Request samples

                                                                              Content type
                                                                              application/json
                                                                              {
                                                                              • "email": "user@example.com",
                                                                              • "role_id": "string"
                                                                              }

                                                                              Response samples

                                                                              Content type
                                                                              application/json
                                                                              {
                                                                              • "error": "string",
                                                                              • "status": {
                                                                                },
                                                                              • "payload": {
                                                                                }
                                                                              }

                                                                              Get Member Details

                                                                              Authorizations:
                                                                              token
                                                                                path Parameters
                                                                                id
                                                                                required
                                                                                string non-empty ^[1-9][0-9]*$

                                                                                ID is the organization id

                                                                                member_id
                                                                                required
                                                                                string >= 1

                                                                                MemberID is the member id

                                                                                Responses

                                                                                Response samples

                                                                                Content type
                                                                                application/json
                                                                                {
                                                                                • "error": "string",
                                                                                • "status": {
                                                                                  },
                                                                                • "payload": {