Retrieve all operations from a schema.

Deprecated

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

Copy endpoint

https://api.cloudflare.com/client/v4

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

Parameters

Name	Type
`schema_id` required Identifier for the schema-ID	string
`zone_id` required	type ApiShieldSchemasIdentifier = type ApiShieldIdentifier = string & string

Name	Type
`feature` 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.	("thresholds" \| "parameter_schemas" \| "schema_info")[]
`host`	string[]
`method`	string[]
`endpoint`	string
`page` Page number of paginated results.	number
`per_page` Maximum number of results per page.	number
`operation_status` 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.	"new" \| "existing"

200 application/json

Retrieve all operations from a schema response

type ApiShieldApiResponseCollection = never & { result: (

ApiShieldOperation

type ApiShieldOperation = { features?: ApiShieldOperationFeatures; } & ApiShieldStandardOperation | null & ApiShieldStandardOperation

ApiShieldBasicOperation

interface ApiShieldBasicOperation {
endpoint: ApiShieldEndpoint;
host: ApiShieldHost;
method: ApiShieldMethod;
}

)[]; }

4XX application/json

Retrieve all operations from a schema response failure

interface ApiShieldApiResponseCommonFailure {
errors:

ApiShieldMessages

type ApiShieldMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
messages:

ApiShieldMessages

type ApiShieldMessages = {
code: number;
documentation_url?: string;
message: string;
source?: { pointer?: string; };
}[]

;
result: null;
success: false;
}