Skip to content
Start here

Operations

Retrieve discovered operations on a zone
client.apiGateway.discovery.operations.list(OperationListParams { zone_id, diff, direction, 8 more } params, RequestOptionsoptions?): V4PagePaginationArray<DiscoveryOperation { id, endpoint, host, 5 more } >
GET/zones/{zone_id}/api_gateway/discovery/operations
Patch discovered operation
client.apiGateway.discovery.operations.edit(stringoperationId, OperationEditParams { zone_id, state } params, RequestOptionsoptions?): OperationEditResponse { state }
PATCH/zones/{zone_id}/api_gateway/discovery/operations/{operation_id}
Patch discovered operations
client.apiGateway.discovery.operations.bulkEdit(OperationBulkEditParams { zone_id, body } params, RequestOptionsoptions?): OperationBulkEditResponse { state }
PATCH/zones/{zone_id}/api_gateway/discovery/operations
ModelsExpand Collapse
OperationEditResponse { state }
state?: "review" | "saved" | "ignored"

State of operation in API Discovery

  • review - Operation is not saved into API Shield Endpoint Management
  • saved - Operation is saved into API Shield Endpoint Management
  • ignored - Operation is marked as ignored
One of the following:
"review"
"saved"
"ignored"
OperationBulkEditResponse = Record<string, item>
state?: "review" | "ignored"

Mark state of operation in API Discovery

  • review - Mark operation as for review
  • ignored - Mark operation as ignored
One of the following:
"review"
"ignored"