API Gateway

APIGateway

API Gateway

Configurations

APIGateway.Configurations

Methods

get(, ):
get/zones/{zone_id}/api_gateway/configuration

Retrieve information about specific configuration properties

update(, ):
put/zones/{zone_id}/api_gateway/configuration

Update configuration properties

Domain types

Configuration{…}
API Gateway

Discovery

APIGateway.Discovery

Methods

get(, ):
get/zones/{zone_id}/api_gateway/discovery

Retrieve the most up to date view of discovered operations, rendered as OpenAPI schemas

Domain types

DiscoveryOperation{…}

APIGateway.Discovery.Operations

Methods

list(, ): <>
get/zones/{zone_id}/api_gateway/discovery/operations

Retrieve the most up to date view of discovered operations

edit(, , ):
patch/zones/{zone_id}/api_gateway/discovery/operations/{operation_id}

Update the state on a discovered operation

bulkEdit(, ):
patch/zones/{zone_id}/api_gateway/discovery/operations

Update the state on one or more discovered operations

API Gateway

Expression Template

APIGateway.ExpressionTemplate

APIGateway.ExpressionTemplate.Fallthrough

Methods

create(, ):
post/zones/{zone_id}/api_gateway/expression-template/fallthrough

Generate fallthrough WAF expression template from a set of API hosts

API Gateway

Operations

APIGateway.Operations

Methods

list(, ): <>
get/zones/{zone_id}/api_gateway/operations

Retrieve information about all operations on a zone

get(, , ):
get/zones/{zone_id}/api_gateway/operations/{operation_id}

Retrieve information about an operation

create(, ):
post/zones/{zone_id}/api_gateway/operations/item

Add one operation to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date.

delete(, , ):
delete/zones/{zone_id}/api_gateway/operations/{operation_id}

Delete an operation

bulkCreate(, ): <>
post/zones/{zone_id}/api_gateway/operations

Add one or more operations to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date.

bulkDelete(, ):
delete/zones/{zone_id}/api_gateway/operations

Delete multiple operations

Domain types

APIShield{…}
API GatewayOperations

Schema Validation

APIGateway.Operations.SchemaValidation

Methods

get(, , ):
Deprecated
get/zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation

Deprecated

Use Schema Validation API instead.

Retrieves operation-level schema validation settings on the zone

update(, , ):
Deprecated
put/zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation

Deprecated

Use Schema Validation API instead.

Updates operation-level schema validation settings on the zone

edit(, ):
Deprecated
patch/zones/{zone_id}/api_gateway/operations/schema_validation

Deprecated

Use Schema Validation API instead.

Updates multiple operation-level schema validation settings on the zone

Domain types

SettingsMultipleRequest = Record<string, >

APIGateway.Schemas

Methods

list(, ):
get/zones/{zone_id}/api_gateway/schemas

Retrieve operations and features as OpenAPI schemas

API Gateway

Settings

APIGateway.Settings

Domain types

Settings{…}
API GatewaySettings

Schema Validation

APIGateway.Settings.SchemaValidation

Methods

get(, ):
Deprecated
get/zones/{zone_id}/api_gateway/settings/schema_validation

Deprecated

Use Schema Validation API instead.

Retrieves zone level schema validation settings currently set on the zone

update(, ):
Deprecated
put/zones/{zone_id}/api_gateway/settings/schema_validation

Deprecated

Use Schema Validation API instead.

Updates zone level schema validation settings on the zone

edit(, ):
Deprecated
patch/zones/{zone_id}/api_gateway/settings/schema_validation

Deprecated

Use Schema Validation API instead.

Updates zone level schema validation settings on the zone

API Gateway

User Schemas

APIGateway.UserSchemas

Methods

list(, ): <>
Deprecated
get/zones/{zone_id}/api_gateway/user_schemas

Deprecated

Use Schema Validation API instead.

Retrieve information about all schemas on a zone

get(, , ):
Deprecated
get/zones/{zone_id}/api_gateway/user_schemas/{schema_id}

Deprecated

Use Schema Validation API instead.

Retrieve information about a specific schema on a zone

create(, ):
Deprecated
post/zones/{zone_id}/api_gateway/user_schemas

Deprecated

Use Schema Validation API instead.

Upload a schema to a zone

edit(, , ):
Deprecated
patch/zones/{zone_id}/api_gateway/user_schemas/{schema_id}

Deprecated

Use Schema Validation API instead.

Enable validation for a schema

delete(, , ):
Deprecated
delete/zones/{zone_id}/api_gateway/user_schemas/{schema_id}

Deprecated

Use Schema Validation API instead.

Delete a schema

Domain types

Message = Array<>
OldPublicSchema{…}

APIGateway.UserSchemas.Hosts

Methods

list(, ): <>
Deprecated
get/zones/{zone_id}/api_gateway/user_schemas/hosts

Deprecated

Use Schema Validation API instead.

Retrieve schema hosts in a zone

APIGateway.UserSchemas.Operations

Methods

list(, , ): <>
Deprecated
get/zones/{zone_id}/api_gateway/user_schemas/{schema_id}/operations

Deprecated

Use Schema Validation API instead.

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