Get Instances by Profile

This article explains the legacy version of WAF that underwent end-of-life on June 30, 2021. Our new version of WAF expands upon all of the capabilities offered by WAF (Legacy) and Rate Limiting (Legacy) with a simplified and centralized setup. Please upgrade to the latest version of WAF at your earliest convenience.

WAF Essential cannot be configured via our APIs. However, you may leverage our APIs to retrieve WAF and Rate Limiting event log data.

Retrieves all WAF instances associated with the specified profile.

A profile cannot be deleted while in use by an instance. This endpoint allows the discovery of the relevant instances.

Request

A request to retrieve instances is described below.

HTTP Method	Request URI
GET	https://api.transactcdn.com/v2/mcc/customers/AccountNumber/waf/config/profiles/ProfileID/instances

Define the following variables when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
AccountNumber Required	Replace this variable with a customer account number. This account number may be found in the upper left-hand corner of the TCC.
ProfileID Required	Replace this variable with the system-defined ID of the desired profile. Use the Get All Profiles endpoint to retrieve a list of profiles and their system-defined IDs.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Request Body

Request body parameters are not required by this endpoint.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request contains the following response parameters for each WAF instance associated with the specified profile:

Name	Data Type	Description
id	Integer	Identifies a WAF instance by its system-defined ID.
name	String	Identifies a WAF instance by its name.

Errors

The response body for an unsuccessful request will contain an error response that provides additional information.

View common error messages.

Sample Request and Response

A sample JSON request is shown below.

A sample JSON response is shown below.

[{
		"id" : 147,
		"name" : "Site A"
	}, {
		"id" : 488,
		"name" : "Site B - Alternate"
	}
]