Rest API Management

CRUD operations for Rest APIs

Create a new RestAPI¶

POST /rest-apis

Code samples

curl -X POST http://localhost:9090/api/management/v0.9/rest-apis \
  -u {username}:{password} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d @payload.json

Add a new RestAPI to the Gateway.

Payload

{
  "apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
  "kind": "RestApi",
  "metadata": {
    "name": "reading-list-api-v1.0"
  },
  "spec": {
    "displayName": "Reading-List-API",
    "version": "v1.0",
    "context": "/reading-list/$version",
    "upstream": {
      "main": {
        "url": "https://apis.bijira.dev/samples/reading-list-api-service/v1.0"
      }
    },
    "policies": [
      {
        "name": "set-headers",
        "version": "v1",
        "params": {
          "request": {
            "headers": [
              {
                "name": "x-wso2-apip-gateway-version",
                "value": "v1.0.0"
              }
            ]
          },
          "response": {
            "headers": [
              {
                "name": "x-environment",
                "value": "development"
              }
            ]
          }
        }
      }
    ],
    "operations": [
      {
        "method": "GET",
        "path": "/books"
      },
      {
        "method": "POST",
        "path": "/books"
      },
      {
        "method": "GET",
        "path": "/books/{id}"
      },
      {
        "method": "PUT",
        "path": "/books/{id}"
      },
      {
        "method": "DELETE",
        "path": "/books/{id}"
      }
    ]
  }
}

Authentication¶

Parameters

Name	In	Type	Required	Description
body	body	RestAPIRequest	true	none

Example responses

201 Response

{
  "apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
  "kind": "RestApi",
  "metadata": {
    "name": "reading-list-api-v1.0"
  },
  "spec": {
    "displayName": "Reading-List-API",
    "version": "v1.0",
    "context": "/reading-list/$version",
    "upstream": {
      "main": {
        "url": "https://apis.bijira.dev/samples/reading-list-api-service/v1.0"
      }
    },
    "policies": [
      {
        "name": "set-headers",
        "version": "v1",
        "params": {
          "request": {
            "headers": [
              {
                "name": "x-wso2-apip-gateway-version",
                "value": "v1.0.0"
              }
            ]
          },
          "response": {
            "headers": [
              {
                "name": "x-environment",
                "value": "development"
              }
            ]
          }
        }
      }
    ],
    "operations": [
      {
        "method": "GET",
        "path": "/books"
      },
      {
        "method": "POST",
        "path": "/books"
      },
      {
        "method": "GET",
        "path": "/books/{id}"
      },
      {
        "method": "PUT",
        "path": "/books/{id}"
      },
      {
        "method": "DELETE",
        "path": "/books/{id}"
      }
    ]
  },
  "status": {
    "id": "reading-list-api-v1.0",
    "state": "deployed",
    "createdAt": "2026-04-24T07:21:13Z",
    "updatedAt": "2026-04-24T07:21:13Z",
    "deployedAt": "2026-04-24T07:21:13Z"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	RestAPI created successfully	RestAPI
400	Bad Request	Invalid configuration (validation failed)	ErrorResponse
409	Conflict	Conflict - API with same name and version already exists	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

List all RestAPIs¶

GET /rest-apis

Code samples

curl -X GET http://localhost:9090/api/management/v0.9/rest-apis \
  -u {username}:{password} \
  -H 'Accept: application/json'

List RestAPIs registered in the Gateway, optionally filtered by name, version, context, or status.

Authentication¶

Parameters

Name	In	Type	Required	Description
displayName	query	string	false	Filter by API display name
version	query	string	false	Filter by API version
context	query	string	false	Filter by API context/path
status	query	string	false	Filter by deployment status

Enumerated Values

Parameter	Value
status	deployed
status	undeployed

Example responses

200 Response

{
  "status": "success",
  "count": 5,
  "apis": [
    {
      "apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
      "kind": "RestApi",
      "metadata": {
        "name": "reading-list-api-v1.0"
      },
      "spec": {
        "displayName": "Reading-List-API",
        "version": "v1.0",
        "context": "/reading-list/$version",
        "upstream": {
          "main": {
            "url": "https://apis.bijira.dev/samples/reading-list-api-service/v1.0"
          }
        },
        "policies": [
          {
            "name": "set-headers",
            "version": "v1",
            "params": {
              "request": {
                "headers": [
                  {
                    "name": "x-wso2-apip-gateway-version",
                    "value": "v1.0.0"
                  }
                ]
              },
              "response": {
                "headers": [
                  {
                    "name": "x-environment",
                    "value": "development"
                  }
                ]
              }
            }
          }
        ],
        "operations": [
          {
            "method": "GET",
            "path": "/books"
          },
          {
            "method": "POST",
            "path": "/books"
          },
          {
            "method": "GET",
            "path": "/books/{id}"
          },
          {
            "method": "PUT",
            "path": "/books/{id}"
          },
          {
            "method": "DELETE",
            "path": "/books/{id}"
          }
        ]
      },
      "status": {
        "id": "reading-list-api-v1.0",
        "state": "deployed",
        "createdAt": "2026-04-24T07:21:13Z",
        "updatedAt": "2026-04-24T07:21:13Z",
        "deployedAt": "2026-04-24T07:21:13Z"
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	List of RestAPIs	Inline
500	Internal Server Error	Internal server error	ErrorResponse

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» count	integer	false	none	none
» apis	[allOf]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	RestAPIRequest	false	none	none
»»» apiVersion	string	true	none	API specification version
»»» kind	string	true	none	API type
»»» metadata	Metadata	true	none	none
»»»» name	string	true	none	Unique handle for the resource
»»»» labels	object	false	none	Labels are key-value pairs for organizing and selecting APIs. Keys must not contain spaces.
»»»»» additionalProperties	string	false	none	none
»»»» annotations	object	false	none	Annotations are arbitrary non-identifying metadata. Use domain-prefixed keys.
»»»»» additionalProperties	string	false	none	none
»»» spec	APIConfigData	true	none	none
»»»» displayName	string	true	none	Human-readable API name (must be URL-friendly - only letters, numbers, spaces, hyphens, underscores, and dots allowed)
»»»» version	string	true	none	Semantic version of the API
»»»» context	string	true	none	Base path for all API routes (must start with /, no trailing slash). Use $version to embed the version in the path (e.g., /reading-list/$ version resolves to /reading-list/v1.0).
»»»» upstreamDefinitions	[UpstreamDefinition]	false	none	List of reusable upstream definitions with optional timeout configurations
»»»»» name	string	true	none	Unique identifier for this upstream definition
»»»»» basePath	string	false	none	Base path prefix for all endpoints in this upstream (e.g., /api/v2). All requests to this upstream will have this path prepended.
»»»»» timeout	UpstreamTimeout	false	none	Timeout configuration for upstream requests
»»»»»» connect	string	false	none	Connection timeout duration (e.g., "5s", "500ms")
»»»»» upstreams	[object]	true	none	List of backend targets with optional weights for load balancing
»»»»»» url	string(uri)	true	none	Backend URL (host and port only, path comes from basePath)
»»»»»» weight	integer	false	none	Weight for load balancing (optional, default 100)
»»»» upstream	object	true	none	API-level upstream configuration
»»»»» main	Upstream	true	none	Upstream backend configuration (single target or reference)
»»»»»» url	string(uri)	false	none	Direct backend URL to route traffic to
»»»»»» ref	string	false	none	Reference to a predefined upstreamDefinition
»»»»»» hostRewrite	string	false	none	Controls how the Host header is handled when routing to the upstream. `auto` delegates host rewriting to Envoy, which rewrites the Host header using the upstream cluster host. `manual` disables automatic rewriting and expects explicit configuration.

oneOf

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none

xor

Name	Type	Required	Restrictions	Description
»»»»»» anonymous	object	false	none	none

continued

Name	Type	Required	Restrictions	Description
»»»»» sandbox	Upstream	false	none	Upstream backend configuration (single target or reference)
»»»» vhosts	object	false	none	Custom virtual hosts/domains for the API
»»»»» main	string	true	none	Custom virtual host/domain for production traffic
»»»»» sandbox	string	false	none	Custom virtual host/domain for sandbox traffic
»»»» subscriptionPlans	[string]	false	none	List of subscription plan names available for this API
»»»» policies	[Policy]	false	none	List of API-level policies applied to all operations unless overridden
»»»»» name	string	true	none	Name of the policy
»»»»» version	string	true	none	Version of the policy. Only major-only version is allowed (e.g., v0, v1). Full semantic version (e.g., v1.0.0) is not accepted and will be rejected. The Gateway Controller resolves the major version to the single matching full version installed in the gateway image.
»»»»» executionCondition	string	false	none	Expression controlling conditional execution of the policy
»»»»» params	object	false	none	Arbitrary parameters for the policy (free-form key/value structure)
»»»» operations	[Operation]	true	none	List of HTTP operations/routes
»»»»» method	string	true	none	HTTP method
»»»»» path	string	true	none	Route path with optional
»»»»» policies	[Policy]	false	none	List of policies applied only to this operation (overrides or adds to API-level policies)
»»»» deploymentState	string	false	none	Desired deployment state - 'deployed' (default) or 'undeployed'. When set to 'undeployed', the API is removed from router traffic but configuration, API keys, and policies are preserved for potential redeployment.

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» status	ResourceStatus	false	read-only	Server-managed lifecycle fields. Populated on responses.
»»»» id	string	false	none	Unique identifier assigned by the server (equal to metadata.name)
»»»» state	string	false	none	Desired deployment state reported by the server
»»»» createdAt	string(date-time)	false	none	Timestamp when the resource was first created (UTC)
»»»» updatedAt	string(date-time)	false	none	Timestamp when the resource was last updated (UTC)
»»»» deployedAt	string(date-time)	false	none	Timestamp when the resource was last deployed (omitted when undeployed)

Enumerated Values

Property	Value
apiVersion	gateway.api-platform.wso2.com/v1alpha1
kind	RestApi
hostRewrite	auto
hostRewrite	manual
method	GET
method	POST
method	PUT
method	DELETE
method	PATCH
method	HEAD
method	OPTIONS
deploymentState	deployed
deploymentState	undeployed
state	deployed
state	undeployed

Get RestAPI by id¶

GET /rest-apis/{id}

Code samples

curl -X GET http://localhost:9090/api/management/v0.9/rest-apis/{id} \
  -u {username}:{password} \
  -H 'Accept: application/json'

Get a RestAPI by its ID.

Authentication¶

Parameters

Name	In	Type	Required	Description
id	path	string	true	Unique public identifier for the API.

Detailed descriptions

id: Unique public identifier for the API.

Example responses

200 Response

{
  "apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
  "kind": "RestApi",
  "metadata": {
    "name": "reading-list-api-v1.0"
  },
  "spec": {
    "displayName": "Reading-List-API",
    "version": "v1.0",
    "context": "/reading-list/$version",
    "upstream": {
      "main": {
        "url": "https://apis.bijira.dev/samples/reading-list-api-service/v1.0"
      }
    },
    "policies": [
      {
        "name": "set-headers",
        "version": "v1",
        "params": {
          "request": {
            "headers": [
              {
                "name": "x-wso2-apip-gateway-version",
                "value": "v1.0.0"
              }
            ]
          },
          "response": {
            "headers": [
              {
                "name": "x-environment",
                "value": "development"
              }
            ]
          }
        }
      }
    ],
    "operations": [
      {
        "method": "GET",
        "path": "/books"
      },
      {
        "method": "POST",
        "path": "/books"
      },
      {
        "method": "GET",
        "path": "/books/{id}"
      },
      {
        "method": "PUT",
        "path": "/books/{id}"
      },
      {
        "method": "DELETE",
        "path": "/books/{id}"
      }
    ]
  },
  "status": {
    "id": "reading-list-api-v1.0",
    "state": "deployed",
    "createdAt": "2026-04-24T07:21:13Z",
    "updatedAt": "2026-04-24T07:21:13Z",
    "deployedAt": "2026-04-24T07:21:13Z"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	RestAPI details	RestAPI
404	Not Found	RestAPI not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Update an existing RestAPI¶

PUT /rest-apis/{id}

Code samples

curl -X PUT http://localhost:9090/api/management/v0.9/rest-apis/{id} \
  -u {username}:{password} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d @payload.json

Update an existing RestAPI in the Gateway.

Payload

{
  "apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
  "kind": "RestApi",
  "metadata": {
    "name": "reading-list-api-v1.0"
  },
  "spec": {
    "displayName": "Reading-List-API",
    "version": "v1.0",
    "context": "/reading-list/$version",
    "upstream": {
      "main": {
        "url": "https://apis.bijira.dev/samples/reading-list-api-service/v1.0"
      }
    },
    "policies": [
      {
        "name": "set-headers",
        "version": "v1",
        "params": {
          "request": {
            "headers": [
              {
                "name": "x-wso2-apip-gateway-version",
                "value": "v1.0.0"
              }
            ]
          },
          "response": {
            "headers": [
              {
                "name": "x-environment",
                "value": "development"
              }
            ]
          }
        }
      }
    ],
    "operations": [
      {
        "method": "GET",
        "path": "/books"
      },
      {
        "method": "POST",
        "path": "/books"
      },
      {
        "method": "GET",
        "path": "/books/{id}"
      },
      {
        "method": "PUT",
        "path": "/books/{id}"
      },
      {
        "method": "DELETE",
        "path": "/books/{id}"
      }
    ]
  }
}

Authentication¶

Parameters

Name	In	Type	Required	Description
id	path	string	true	Unique public identifier of the API to update.
body	body	RestAPIRequest	true	none

Detailed descriptions

id: Unique public identifier of the API to update.

Example responses

200 Response

{
  "apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
  "kind": "RestApi",
  "metadata": {
    "name": "reading-list-api-v1.0"
  },
  "spec": {
    "displayName": "Reading-List-API",
    "version": "v1.0",
    "context": "/reading-list/$version",
    "upstream": {
      "main": {
        "url": "https://apis.bijira.dev/samples/reading-list-api-service/v1.0"
      }
    },
    "policies": [
      {
        "name": "set-headers",
        "version": "v1",
        "params": {
          "request": {
            "headers": [
              {
                "name": "x-wso2-apip-gateway-version",
                "value": "v1.0.0"
              }
            ]
          },
          "response": {
            "headers": [
              {
                "name": "x-environment",
                "value": "development"
              }
            ]
          }
        }
      }
    ],
    "operations": [
      {
        "method": "GET",
        "path": "/books"
      },
      {
        "method": "POST",
        "path": "/books"
      },
      {
        "method": "GET",
        "path": "/books/{id}"
      },
      {
        "method": "PUT",
        "path": "/books/{id}"
      },
      {
        "method": "DELETE",
        "path": "/books/{id}"
      }
    ]
  },
  "status": {
    "id": "reading-list-api-v1.0",
    "state": "deployed",
    "createdAt": "2026-04-24T07:21:13Z",
    "updatedAt": "2026-04-24T07:21:13Z",
    "deployedAt": "2026-04-24T07:21:13Z"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	RestAPI updated successfully	RestAPI
400	Bad Request	Invalid configuration (validation failed)	ErrorResponse
404	Not Found	RestAPI not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Delete a RestAPI¶

DELETE /rest-apis/{id}

Code samples

curl -X DELETE http://localhost:9090/api/management/v0.9/rest-apis/{id} \
  -u {username}:{password} \
  -H 'Accept: application/json'

Delete a RestAPI from the Gateway.

Authentication¶

Parameters

Name	In	Type	Required	Description
id	path	string	true	Unique public identifier of the API to delete.

Detailed descriptions

id: Unique public identifier of the API to delete.

Example responses

200 Response

{
  "status": "success",
  "message": "RestAPI deleted successfully",
  "id": "reading-list-api-v1.0"
}

Responses

Status	Meaning	Description	Schema
200	OK	RestAPI deleted successfully	Inline
404	Not Found	RestAPI not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» status	string	false	none	none
» message	string	false	none	none
» id	string	false	none	none

Create a new API key for an API¶

POST /rest-apis/{id}/api-keys

Code samples

curl -X POST http://localhost:9090/api/management/v0.9/rest-apis/{id}/api-keys \
  -u {username}:{password} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d @payload.json

Generate a new API key for a RestAPI in the Gateway. The key is a 32-byte random value encoded in hexadecimal, prefixed with apip_. Use the API Key policy on the API to validate incoming requests with this key.

Payload

{
  "name": "my-production-key"
}

Authentication¶

Parameters

Name	In	Type	Required	Description
id	path	string	true	Unique public identifier of the API to generate the key for
body	body	APIKeyCreationRequest	true	none

Detailed descriptions

id: Unique public identifier of the API to generate the key for

Example responses

201 Response

{
  "status": "success",
  "message": "API key generated successfully",
  "remainingApiKeyQuota": 9,
  "apiKey": {
    "name": "my-production-key",
    "displayName": "My Production Key",
    "apiKey": "apip_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "apiId": "reading-list-api-v1.0",
    "status": "active",
    "createdAt": "2026-04-01T10:30:00Z",
    "createdBy": "admin",
    "expiresAt": null,
    "source": "local"
  }
}

Responses

Status	Meaning	Description	Schema
201	Created	API key created successfully	APIKeyCreationResponse
400	Bad Request	Invalid configuration (validation failed)	ErrorResponse
404	Not Found	RestAPI not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Get the list of API keys for an API¶

GET /rest-apis/{id}/api-keys

Code samples

curl -X GET http://localhost:9090/api/management/v0.9/rest-apis/{id}/api-keys \
  -u {username}:{password} \
  -H 'Accept: application/json'

List all API keys for a RestAPI in the Gateway.

Authentication¶

Parameters

Name	In	Type	Required	Description
id	path	string	true	Unique public identifier of the API to retrieve the keys for

Detailed descriptions

id: Unique public identifier of the API to retrieve the keys for

Example responses

200 Response

{
  "apiKeys": [
    {
      "name": "my-production-key",
      "displayName": "My Production Key",
      "apiKey": "apip_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
      "apiId": "reading-list-api-v1.0",
      "status": "active",
      "createdAt": "2026-04-01T10:30:00Z",
      "createdBy": "admin",
      "expiresAt": null,
      "source": "local"
    }
  ],
  "totalCount": 3,
  "status": "success"
}

Responses

Status	Meaning	Description	Schema
200	OK	List of API keys	APIKeyListResponse
404	Not Found	RestAPI not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Regenerate API key for an API¶

POST /rest-apis/{id}/api-keys/{apiKeyName}/regenerate

Code samples

curl -X POST http://localhost:9090/api/management/v0.9/rest-apis/{id}/api-keys/{apiKeyName}/regenerate \
  -u {username}:{password} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d @payload.json

Regenerate an existing API key for a RestAPI in the Gateway. The previous key is revoked and replaced with a new 32-byte random value encoded in hexadecimal, prefixed with apip_.

Payload

{}

Authentication¶

Parameters

Name	In	Type	Required	Description
id	path	string	true	Unique public identifier of the API to generate the key for
apiKeyName	path	string	true	Name of the API key to regenerate
body	body	APIKeyRegenerationRequest	true	none

Detailed descriptions

id: Unique public identifier of the API to generate the key for

apiKeyName: Name of the API key to regenerate

Example responses

200 Response

{
  "status": "success",
  "message": "API key generated successfully",
  "remainingApiKeyQuota": 9,
  "apiKey": {
    "name": "my-production-key",
    "displayName": "My Production Key",
    "apiKey": "apip_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "apiId": "reading-list-api-v1.0",
    "status": "active",
    "createdAt": "2026-04-01T10:30:00Z",
    "createdBy": "admin",
    "expiresAt": null,
    "source": "local"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	API key rotated successfully	APIKeyCreationResponse
400	Bad Request	Invalid configuration (validation failed)	ErrorResponse
404	Not Found	RestAPI not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Update an API key with a new regenerated value¶

PUT /rest-apis/{id}/api-keys/{apiKeyName}

Code samples

curl -X PUT http://localhost:9090/api/management/v0.9/rest-apis/{id}/api-keys/{apiKeyName} \
  -u {username}:{password} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d @payload.json

Update an API key with a custom value instead of auto-generating one.

Payload

{
  "name": "my-production-key"
}

Authentication¶

Parameters

Name	In	Type	Required	Description
id	path	string	true	Unique public identifier of the API
apiKeyName	path	string	true	Name of the API key to update
body	body	APIKeyUpdateRequest	true	none

Detailed descriptions

id: Unique public identifier of the API

apiKeyName: Name of the API key to update

Example responses

200 Response

{
  "status": "success",
  "message": "API key generated successfully",
  "remainingApiKeyQuota": 9,
  "apiKey": {
    "name": "my-production-key",
    "displayName": "My Production Key",
    "apiKey": "apip_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "apiId": "reading-list-api-v1.0",
    "status": "active",
    "createdAt": "2026-04-01T10:30:00Z",
    "createdBy": "admin",
    "expiresAt": null,
    "source": "local"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	API key updated successfully	APIKeyCreationResponse
400	Bad Request	Invalid request (validation failed)	ErrorResponse
404	Not Found	API or API key not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Revoke an API key¶

DELETE /rest-apis/{id}/api-keys/{apiKeyName}

Code samples

curl -X DELETE http://localhost:9090/api/management/v0.9/rest-apis/{id}/api-keys/{apiKeyName} \
  -u {username}:{password} \
  -H 'Accept: application/json'

Revoke an API key. Once revoked, it can no longer be used to authenticate requests.

Authentication¶

Parameters

Name	In	Type	Required	Description
id	path	string	true	Unique public identifier of the API to revoke the key for
apiKeyName	path	string	true	Name of the API key to revoke

Detailed descriptions

id: Unique public identifier of the API to revoke the key for

apiKeyName: Name of the API key to revoke

Example responses

200 Response

{
  "status": "success",
  "message": "API key revoked successfully"
}

Responses

Status	Meaning	Description	Schema
200	OK	API key revoked successfully	APIKeyRevocationResponse
400	Bad Request	Invalid configuration (validation failed)	ErrorResponse
404	Not Found	RestAPI not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Create a subscription plan¶

POST /subscription-plans

Code samples

curl -X POST http://localhost:9090/api/management/v0.9/subscription-plans \
  -u {username}:{password} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d @payload.json

Create a subscription plan that defines rate limits and access tiers for API subscriptions.

Payload

{
  "planName": "Gold",
  "billingPlan": "COMMERCIAL",
  "stopOnQuotaReach": true,
  "throttleLimitCount": 1000,
  "throttleLimitUnit": "Hour",
  "expiryTime": "2026-12-31T23:59:59Z",
  "status": "ACTIVE"
}

Authentication¶

Parameters

Name	In	Type	Required	Description
body	body	SubscriptionPlanCreateRequest	true	none

Example responses

201 Response

{
  "id": "string",
  "planName": "string",
  "billingPlan": "string",
  "stopOnQuotaReach": true,
  "throttleLimitCount": 0,
  "throttleLimitUnit": "string",
  "expiryTime": "2019-08-24T14:15:22Z",
  "gatewayId": "string",
  "status": "ACTIVE",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Responses

Status	Meaning	Description	Schema
201	Created	Subscription plan created	SubscriptionPlanResponse
400	Bad Request	Bad request	ErrorResponse
409	Conflict	Conflict	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

List subscription plans¶

GET /subscription-plans

Code samples

curl -X GET http://localhost:9090/api/management/v0.9/subscription-plans \
  -u {username}:{password} \
  -H 'Accept: application/json'

List all subscription plans available in the Gateway.

Authentication¶

Example responses

200 Response

{
  "subscriptionPlans": [
    {
      "id": "string",
      "planName": "string",
      "billingPlan": "string",
      "stopOnQuotaReach": true,
      "throttleLimitCount": 0,
      "throttleLimitUnit": "string",
      "expiryTime": "2019-08-24T14:15:22Z",
      "gatewayId": "string",
      "status": "ACTIVE",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "count": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of subscription plans	SubscriptionPlanListResponse
500	Internal Server Error	Internal server error	ErrorResponse

Get a subscription plan by ID¶

GET /subscription-plans/{planId}

Code samples

curl -X GET http://localhost:9090/api/management/v0.9/subscription-plans/{planId} \
  -u {username}:{password} \
  -H 'Accept: application/json'

Get the details of a subscription plan by its ID.

Authentication¶

Parameters

Name	In	Type	Required	Description
planId	path	string	true	none

Example responses

200 Response

{
  "id": "string",
  "planName": "string",
  "billingPlan": "string",
  "stopOnQuotaReach": true,
  "throttleLimitCount": 0,
  "throttleLimitUnit": "string",
  "expiryTime": "2019-08-24T14:15:22Z",
  "gatewayId": "string",
  "status": "ACTIVE",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Subscription plan details	SubscriptionPlanResponse
404	Not Found	Not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Update a subscription plan¶

PUT /subscription-plans/{planId}

Code samples

curl -X PUT http://localhost:9090/api/management/v0.9/subscription-plans/{planId} \
  -u {username}:{password} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d @payload.json

Update an existing subscription plan in the Gateway.

Payload

{
  "planName": "string",
  "billingPlan": "string",
  "stopOnQuotaReach": true,
  "throttleLimitCount": 0,
  "throttleLimitUnit": "Min",
  "expiryTime": "2019-08-24T14:15:22Z",
  "status": "ACTIVE"
}

Authentication¶

Parameters

Name	In	Type	Required	Description
planId	path	string	true	none
body	body	SubscriptionPlanUpdateRequest	false	none

Example responses

200 Response

{
  "id": "string",
  "planName": "string",
  "billingPlan": "string",
  "stopOnQuotaReach": true,
  "throttleLimitCount": 0,
  "throttleLimitUnit": "string",
  "expiryTime": "2019-08-24T14:15:22Z",
  "gatewayId": "string",
  "status": "ACTIVE",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Subscription plan updated	SubscriptionPlanResponse
404	Not Found	Not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Delete a subscription plan¶

DELETE /subscription-plans/{planId}

Code samples

curl -X DELETE http://localhost:9090/api/management/v0.9/subscription-plans/{planId} \
  -u {username}:{password} \
  -H 'Accept: application/json'

Delete a subscription plan from the Gateway.

Authentication¶

Parameters

Name	In	Type	Required	Description
planId	path	string	true	none

Example responses

404 Response

{
  "status": "error",
  "message": "Configuration validation failed",
  "errors": [
    {
      "field": "spec.context",
      "message": "Context must start with / and cannot end with /"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
204	No Content	Subscription plan deleted	None
404	Not Found	Not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Create a subscription¶

POST /subscriptions

Code samples

curl -X POST http://localhost:9090/api/management/v0.9/subscriptions \
  -u {username}:{password} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d @payload.json

Subscribe an application to a RestAPI in the Gateway.

Payload

{
  "apiId": "c9f2b6ae-1234-5678-9abc-def012345678",
  "subscriptionToken": "sub-token-abc123xyz",
  "applicationId": "string",
  "subscriptionPlanId": "string",
  "billingCustomerId": "string",
  "billingSubscriptionId": "string",
  "status": "ACTIVE"
}

Authentication¶

Parameters

Name	In	Type	Required	Description
body	body	SubscriptionCreateRequest	true	none

Example responses

201 Response

{
  "id": "string",
  "apiId": "string",
  "applicationId": "string",
  "subscriptionToken": "string",
  "subscriptionPlanId": "string",
  "billingCustomerId": "string",
  "billingSubscriptionId": "string",
  "gatewayId": "string",
  "status": "ACTIVE",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Responses

Status	Meaning	Description	Schema
201	Created	Subscription created	SubscriptionResponse
400	Bad Request	Bad request	ErrorResponse
409	Conflict	Conflict - subscription already exists	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

List subscriptions¶

GET /subscriptions

Code samples

curl -X GET http://localhost:9090/api/management/v0.9/subscriptions \
  -u {username}:{password} \
  -H 'Accept: application/json'

List subscriptions in the Gateway, optionally filtered by API, application, or status.

Authentication¶

Parameters

Name	In	Type	Required	Description
apiId	query	string	false	Filter by API ID (deployment ID or handle)
applicationId	query	string	false	none
status	query	string	false	none

Enumerated Values

Parameter	Value
status	ACTIVE
status	INACTIVE
status	REVOKED

Example responses

200 Response

{
  "subscriptions": [
    {
      "id": "string",
      "apiId": "string",
      "applicationId": "string",
      "subscriptionToken": "string",
      "subscriptionPlanId": "string",
      "billingCustomerId": "string",
      "billingSubscriptionId": "string",
      "gatewayId": "string",
      "status": "ACTIVE",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "count": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of subscriptions	SubscriptionListResponse
500	Internal Server Error	Internal server error	ErrorResponse

Get a subscription by ID¶

GET /subscriptions/{subscriptionId}

Code samples

curl -X GET http://localhost:9090/api/management/v0.9/subscriptions/{subscriptionId} \
  -u {username}:{password} \
  -H 'Accept: application/json'

Get the details of a subscription by its ID.

Authentication¶

Parameters

Name	In	Type	Required	Description
subscriptionId	path	string	true	none

Example responses

200 Response

{
  "id": "string",
  "apiId": "string",
  "applicationId": "string",
  "subscriptionToken": "string",
  "subscriptionPlanId": "string",
  "billingCustomerId": "string",
  "billingSubscriptionId": "string",
  "gatewayId": "string",
  "status": "ACTIVE",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Subscription details	SubscriptionResponse
404	Not Found	Subscription not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Update a subscription¶

PUT /subscriptions/{subscriptionId}

Code samples

curl -X PUT http://localhost:9090/api/management/v0.9/subscriptions/{subscriptionId} \
  -u {username}:{password} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d @payload.json

Update an existing subscription in the Gateway.

Payload

{
  "status": "ACTIVE"
}

Authentication¶

Parameters

Name	In	Type	Required	Description
subscriptionId	path	string	true	none
body	body	SubscriptionUpdateRequest	false	none

Example responses

200 Response

{
  "id": "string",
  "apiId": "string",
  "applicationId": "string",
  "subscriptionToken": "string",
  "subscriptionPlanId": "string",
  "billingCustomerId": "string",
  "billingSubscriptionId": "string",
  "gatewayId": "string",
  "status": "ACTIVE",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	Subscription updated	SubscriptionResponse
404	Not Found	Subscription not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse

Delete a subscription¶

DELETE /subscriptions/{subscriptionId}

Code samples

curl -X DELETE http://localhost:9090/api/management/v0.9/subscriptions/{subscriptionId} \
  -u {username}:{password} \
  -H 'Accept: application/json'

Delete a subscription from the Gateway.

Authentication¶

Parameters

Name	In	Type	Required	Description
subscriptionId	path	string	true	none

Example responses

404 Response

{
  "status": "error",
  "message": "Configuration validation failed",
  "errors": [
    {
      "field": "spec.context",
      "message": "Context must start with / and cannot end with /"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
204	No Content	Subscription deleted	None
404	Not Found	Subscription not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse