Guided Configuration API (1.0)

Download OpenAPI specification:Download

Declarative API to create configuration for API Protection and Azure AD Application Integration use cases in Guided Configuration

Authentication

basicAuth

Security Scheme Type HTTP
HTTP Authorization Scheme basic

Configurations

POST method to add or modify configuration objects.

Method to add or modify configuration objects.

Authorizations:
Request Body schema: application/json
name
required
string (Name) [ 1 .. 128 ] ^.*$

Specifies the configuration name.

type
required
string (Type)
Enum: "GCAPI_AAD_APPS" "GCAPI_API_PROTECTION"

Specifies the type of AGC API request.

action
required
string (Action)
Enum: "ADD" "DELETE"

Specifies the API action to perform.
ADD: Configuration is created if it is not already present. If the configuration already exists, it is updated.
DELETE: Configuration is deleted.

required
Azure AD Application Integration Inputs (object) or API Protection Inputs object (object) (Inputs)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "GCAPI_API_PROTECTION",
  • "action": "ADD",
  • "inputs": {
    }
}

Response samples

Content type