GET /zones/{zone_id}/api_gateway/user_schemas/{schema_id}/operations

Retrieves all operations from the schema. Operations that already exist in API Shield Endpoint Management will be returned as full operations.

Servers

Path parameters

Name Type Required Description
zone_id String Yes
schema_id String Yes

Identifier for the schema-ID

Query parameters

Name Type Required Description
page Integer No

Page number of paginated results.

Default value: 1

method[] Array No
per_page Integer No

Maximum number of results per page.

Default value: 20

feature[] Array No

Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.

host[] Array No
endpoint String No
operation_status String No

Filter results by whether operations exist in API Shield Endpoint Management or not. new will just return operations from the schema that do not exist in API Shield Endpoint Management. existing will just return operations from the schema that already exist in API Shield Endpoint Management.

Possible values:

  • "new"
  • "existing"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.