@itentialopensource/adapter-akamai_gtm
Version:
This adapter integrates with Akamai Global Traffic Management
1,676 lines • 220 kB
JSON
{
"id": "@itentialopensource/adapter-akamai_gtm",
"type": "Adapter",
"export": "AkamaiGtm",
"title": "Akamai_gtm",
"src": "adapter.js",
"roles": [
"admin"
],
"methods": [
{
"name": "iapUpdateAdapterConfiguration",
"summary": "Updates the adapter configuration",
"description": "Updates the adapter configuration file with the provided changes",
"input": [
{
"name": "configFile",
"type": "string",
"info": "The name of the file to change",
"required": true,
"schema": {
"title": "configFile",
"type": "string"
}
},
{
"name": "changes",
"type": "object",
"info": "JSON object containing the configuration changes",
"required": true,
"schema": {
"title": "changes",
"type": "object"
}
},
{
"name": "entity",
"type": "string",
"info": "The entity in which the changes are being made",
"required": false,
"schema": {
"title": "entity",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "The type of file to change - action, schema, or mock",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "action",
"type": "string",
"info": "The action to be changed",
"required": false,
"schema": {
"title": "action",
"type": "string"
}
},
{
"name": "replace",
"type": "boolean",
"info": "True to replace entire mock data, false to merge/append",
"required": false,
"schema": {
"title": "replace",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUpdateAdapterConfiguration"
},
"task": true
},
{
"name": "iapSuspendAdapter",
"summary": "Suspends the adapter",
"description": "Suspends the adapter",
"input": [
{
"name": "mode",
"type": "enum",
"enumerals": [
"pause",
"error"
],
"info": "How incoming requests are handled. Defaults to 'pause'",
"description": "How incoming requests are handled. Defaults to 'pause'",
"schema": {
"title": "mode",
"type": "string"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapSuspendAdapter"
},
"task": true
},
{
"name": "iapUnsuspendAdapter",
"summary": "Unsuspends the adapter",
"description": "Unsuspends the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUnsuspendAdapter"
},
"task": true
},
{
"name": "iapGetAdapterQueue",
"summary": "Return the requests that are waiting in the queue if throttling is enabled",
"description": "Return the requests that are waiting in the queue if throttling is enabled",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter queue",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetAdapterQueue"
},
"task": true
},
{
"name": "iapFindAdapterPath",
"summary": "Provides the ability to see if a particular API path is supported by the adapter",
"description": "Provides the ability to see if a particular API path is supported by the adapter",
"input": [
{
"name": "apiPath",
"type": "string",
"info": "The API Path you want to check - make sure to not include base path and version",
"description": "The API Path you want to check - make sure to not include base path and version",
"schema": {
"title": "apiPath",
"type": "string"
},
"required": true
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapFindAdapterPath"
},
"task": true
},
{
"name": "iapTroubleshootAdapter",
"summary": "Runs troubleshoot script for adapter",
"description": "Runs troubleshoot script for adapter",
"input": [
{
"name": "props",
"type": "object",
"info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
"required": true,
"schema": {
"title": "props",
"type": "object"
}
},
{
"name": "persistFlag",
"type": "boolean",
"info": "Whether the input properties should be saved",
"required": true,
"schema": {
"title": "persistFlag",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapTroubleshootAdapter"
},
"task": true
},
{
"name": "iapRunAdapterHealthcheck",
"summary": "Runs healthcheck script for adapter",
"description": "Runs healthcheck script for adapter",
"input": [],
"output": {
"name": "result",
"type": "boolean",
"description": "Whether healthcheck passed or failed",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterHealthcheck"
},
"task": true
},
{
"name": "iapRunAdapterConnectivity",
"summary": "Runs connectivity check script for adapter",
"description": "Runs connectivity check script for adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterConnectivity"
},
"task": true
},
{
"name": "iapRunAdapterBasicGet",
"summary": "Runs basicGet script for adapter",
"description": "Runs basicGet script for adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterBasicGet"
},
"task": true
},
{
"name": "iapMoveAdapterEntitiesToDB",
"summary": "Moves entities from an adapter into the IAP database",
"description": "Moves entities from an adapter into the IAP database",
"input": [],
"output": {
"name": "res",
"type": "object",
"description": "A JSON Object containing status, code and the response from the mongo transaction",
"schema": {
"title": "res",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapMoveAdapterEntitiesToDB"
},
"task": true
},
{
"name": "iapDeactivateTasks",
"summary": "Deactivate the inputted tasks",
"description": "Deactivate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to deactivate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapDeactivateTasks"
},
"task": true
},
{
"name": "iapActivateTasks",
"summary": "Activate the inputted tasks",
"description": "activate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to activate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapActivateTasks"
},
"task": true
},
{
"name": "iapPopulateEntityCache",
"summary": "Populate the cache for the given entities",
"description": "Populate the cache for the given entities",
"input": [
{
"name": "entityTypes",
"type": "array",
"info": "the entity type(s) to populate",
"required": true,
"schema": {
"title": "entityTypes",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapPopulateEntityCache"
},
"task": true
},
{
"name": "iapRetrieveEntitiesCache",
"summary": "Retrieves data from cache for specified entity type",
"description": "Retrieves data from cache for specified entity type",
"input": [
{
"name": "entityType",
"type": "string",
"info": "entity of which to retrieve",
"required": true,
"schema": {
"title": "entityType",
"type": "string"
}
},
{
"name": "options",
"type": "object",
"info": "settings of which data to return and how to return it",
"required": false,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRetrieveEntitiesCache"
},
"task": true
},
{
"name": "getDevice",
"summary": "Get the Appliance",
"description": "Get the Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevice"
},
"task": false
},
{
"name": "getDevicesFiltered",
"summary": "Get Appliances that match the filter",
"description": "Get Appliances that match the filter",
"input": [
{
"name": "options",
"type": "object",
"info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
"required": true,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "array",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "array"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevicesFiltered"
},
"task": false
},
{
"name": "isAlive",
"summary": "Checks the status for the provided Appliance",
"description": "Checks the status for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "boolean",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/isAlive"
},
"task": false
},
{
"name": "getConfig",
"summary": "Gets a config for the provided Appliance",
"description": "Gets a config for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "format",
"type": "string",
"info": "The format to be returned - this is ignored as we always return json",
"required": false,
"schema": {
"title": "format",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getConfig"
},
"task": false
},
{
"name": "iapGetDeviceCount",
"summary": "Gets a device count from the system",
"description": "Gets a device count from the system",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetDeviceCount"
},
"task": false
},
{
"name": "iapExpandedGenericAdapterRequest",
"summary": "Makes the requested generic call with additional options",
"description": "Makes the requested generic call with additional options via metadata",
"input": [
{
"name": "metadata",
"type": "object",
"info": "metadata for the call (optional)",
"description": "metadata for the call - allows for many enhancements (optional)",
"schema": {
"title": "metadata",
"type": "object"
},
"required": false
},
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": false
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": false
},
{
"name": "pathVars",
"type": "object",
"info": "the parameters to be put within the url path (optional)",
"description": "the parameters to be put within the url path (optional)",
"schema": {
"title": "pathVars",
"type": "object"
},
"required": false
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapExpandedGenericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequest",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequestNoBasePath",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequestNoBasePath"
},
"task": true
},
{
"name": "iapRunAdapterLint",
"summary": "Run the adapter lint script to return the results",
"description": "Run the adapter lint script to return the results",
"input": [],
"output": {
"name": "result",
"type": "string",
"description": "A string containing the run results",
"schema": {
"title": "result",
"type": "string"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterLint"
},
"task": true
},
{
"name": "iapRunAdapterTests",
"summary": "Run the adapter test scripts (baseunit and unit) to return the results",
"description": "Run the adapter test scripts (baseunit and unit) to return the results",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterTests"
},
"task": true
},
{
"name": "iapGetAdapterInventory",
"summary": "Provide inventory information abbout the adapter",
"description": "Provide inventory information abbout the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapGetAdapterInventory"
},
"task": true
},
{
"name": "getDomainNameAsMaps",
"summary": "List AS maps: Returns a list of AS maps.",
"description": "List AS maps: Returns a list of AS maps.",
"input": [
{
"name": "domainName",
"type": "string",
"info": ": string",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDomainNameAsMaps"
},
"task": true
},
{
"name": "getDomainNameAsMapsMapName",
"summary": "Get an AS map: Returns information for a specific AS map.",
"description": "Get an AS map: Returns information for a specific AS map.",
"input": [
{
"name": "mapName",
"type": "string",
"info": "Unique name for the AS map.: string",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
},
{
"name": "domainName",
"type": "string",
"info": "The full GTM domain name.: string",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"description": "Contains information about the AS map configured for the property.",
"type": "object",
"additionalProperties": false,
"properties": {
"assignments": {
"type": "array",
"items": {
"description": "Contains information about the AS zone groupings of AS IDs.",
"type": "object",
"additionalProperties": false,
"properties": {
"asNumbers": {
"type": "array",
"items": {
"minimum": 1,
"maximum": 4294967295,
"description": "Specifies an array of AS numbers.",
"type": "integer"
}
},
"datacenterId": {
"description": "A unique identifier for an existing data center in the domain.",
"type": "integer"
},
"nickname": {
"minLength": 1,
"maxLength": 128,
"description": "A descriptive label for the group.",
"type": "string"
}
},
"required": [
"asNumbers",
"datacenterId",
"nickname"
]
}
},
"defaultDatacenter": {
"description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.",
"type": "object",
"additionalProperties": false,
"properties": {
"datacenterId": {
"description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.",
"type": "integer"
},
"nickname": {
"minLength": 1,
"maxLength": 128,
"description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.",
"type": "string"
}
},
"required": [
"datacenterId",
"nickname"
]
},
"name": {
"minLength": 1,
"maxLength": 128,
"description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.",
"type": "string"
},
"links": {
"type": "array",
"items": {
"description": "Specifies the URL path that allows direct navigation to the As map."
}
}
},
"required": [
"assignments",
"defaultDatacenter",
"name"
]
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDomainNameAsMapsMapName"
},
"task": true
},
{
"name": "putDomainNameAsMapsMapName",
"summary": "Create or update an AS map: Run this operation to create or\nupdate an AS map.",
"description": "Create or update an AS map: Run this operation to create or\nupdate an AS map.",
"input": [
{
"name": "mapName",
"type": "string",
"info": "Unique name for the AS map.: string",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
},
{
"name": "domainName",
"type": "string",
"info": "The full GTM domain name.: string",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"assignments\": [{\"asNumbers\": \"array\", \"datacenterId\": 123, \"nickname\": \"string\"}], \"defaultDatacenter\": {\"datacenterId\": 123, \"nickname\": \"string\"}, \"name\": \"string\", \"links\": \"array\"}",
"required": false,
"schema": {
"description": "Contains information about the AS map configured for the property.",
"type": "object",
"additionalProperties": false,
"properties": {
"assignments": {
"type": "array",
"items": {
"description": "Contains information about the AS zone groupings of AS IDs.",
"type": "object",
"additionalProperties": false,
"properties": {
"asNumbers": {
"type": "array",
"items": {
"minimum": 1,
"maximum": 4294967295,
"description": "Specifies an array of AS numbers.",
"type": "integer"
}
},
"datacenterId": {
"description": "A unique identifier for an existing data center in the domain.",
"type": "integer"
},
"nickname": {
"minLength": 1,
"maxLength": 128,
"description": "A descriptive label for the group.",
"type": "string"
}
},
"required": [
"asNumbers",
"datacenterId",
"nickname"
]
}
},
"defaultDatacenter": {
"description": "A placeholder for all other AS zones, AS IDs not found in these AS zones. Note that an AS map can't have the same AS ID in multiple AS zones.",
"type": "object",
"additionalProperties": false,
"properties": {
"datacenterId": {
"description": "For each property, an identifier for all other AS zones' CNAME. For example, 5400.",
"type": "integer"
},
"nickname": {
"minLength": 1,
"maxLength": 128,
"description": "A descriptive label for all other AS zones, up to 128 characters. If the value is empty or `null`, the default is `Default Mapping`.",
"type": "string"
}
},
"required": [
"datacenterId",
"nickname"
]
},
"name": {
"minLength": 1,
"maxLength": 128,
"description": "A descriptive label for the AS map. Properties set up for asmapping can use this as reference.",
"type": "string"
},
"links": {
"type": "array",
"items": {
"description": "Specifies the URL path that allows direct navigation to the As map."
}
}
},
"required": [
"assignments",
"defaultDatacenter",
"name"
]
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "string"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/putDomainNameAsMapsMapName"
},
"task": true
},
{
"name": "deleteDomainNameAsMapsMapName",
"summary": "Remove an AS map: Removes a specific AS map.",
"description": "Remove an AS map: Removes a specific AS map.",
"input": [
{
"name": "mapName",
"type": "string",
"info": "Unique name for the AS map.: string",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
},
{
"name": "domainName",
"type": "string",
"info": "The full GTM domain name.: string",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "string"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteDomainNameAsMapsMapName"
},
"task": true
},
{
"name": "getDomainNameCidrMaps",
"summary": "List CIDR maps: Returns a list of CIDR maps.",
"description": "List CIDR maps: Returns a list of CIDR maps.",
"input": [
{
"name": "domainName",
"type": "string",
"info": "The full GTM domain name.: string",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDomainNameCidrMaps"
},
"task": true
},
{
"name": "getDomainNameCidrMapsMapName",
"summary": "Get a CIDR map: Returns information for a specific CIDR map.",
"description": "Get a CIDR map: Returns information for a specific CIDR map.",
"input": [
{
"name": "mapName",
"type": "string",
"info": "Unique name for the CIDR map.: string",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
},
{
"name": "domainName",
"type": "string",
"info": "The full GTM domain name.: string",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDomainNameCidrMapsMapName"
},
"task": true
},
{
"name": "putDomainNameCidrMapsMapName",
"summary": "Create or update a CIDR map: Run this operation to create or update a CIDR map.",
"description": "Create or update a CIDR map: Run this operation to create or update a CIDR map.",
"input": [
{
"name": "mapName",
"type": "string",
"info": "Unique name for the CIDR map.: string",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
},
{
"name": "domainName",
"type": "string",
"info": "The full GTM domain name.: string",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"name\": \"string\", \"assignments\": [{\"datacenterId\": 123, \"nickname\": \"string\", \"blocks\": \"array\"}], \"defaultDatacenter\": {\"datacenterId\": 123, \"nickname\": \"string\"}, \"links\": \"array\"}",
"required": false,
"schema": {
"description": "Contains information about the CIDR map configured for the property.",
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"minLength": 1,
"maxLength": 255,
"description": "A descriptive label for the CIDR map, up to 255 characters.",
"type": "string"
},
"assignments": {
"type": "array",
"items": {
"description": "Contains information about the CIDR zone groupings of CIDR blocks.",
"type": "object",
"additionalProperties": false,
"properties": {
"datacenterId": {
"description": "A unique identifier for an existing data center in the domain.",
"type": "integer"
},
"nickname": {
"minLength": 1,
"maxLength": 256,
"description": "A descriptive label for the CIDR zone group, up to 256 characters.",
"type": "string"
},
"blocks": {
"type": "array",
"items": {
"minLength": 1,
"maxLength": 256,
"description": "Specifies an array of CIDR blocks.",
"type": "string"
}
}
}
}
},
"defaultDatacenter": {
"description": "A placeholder for all other CIDR zones, CIDR blocks not found in these CIDR zones. Note that a CIDR map can't have the same CIDR block in multiple CIDR zones. ",
"type": "object",
"additionalProperties": false,
"properties": {
"datacenterId": {
"description": "For each property, an identifier for all other CIDR zones' CNAME. For example, 5400.",
"type": "integer"
},
"nickname": {
"minLength": 1,
"maxLength": 128,
"description": "A descriptive label for the all other CIDR blocks. If omitted, the default is `All Other CIDR Blocks`.",
"type": "string"
}
}
},
"links": {
"type": "array",
"items": {
"description": "Specifies the URL path that allows direct navigation to the CIDR map."
}
}
}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"resource": {
"type": "object"
},
"status": {
"type": "object"
}
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/putDomainNameCidrMapsMapName"
},
"task": true
},
{
"name": "deleteDomainNameCidrMapsMapName",
"summary": "Remove a CIDR map: Removes a specific CIDR map.",
"description": "Remove a CIDR map: Removes a specific CIDR map.",
"input": [
{
"name": "mapName",
"type": "string",
"info": "Unique name for the CIDR map.: string",
"required": true,
"schema": {
"title": "mapName",
"type": "string"
}
},
{
"name": "domainName",
"type": "string",
"info": "The full GTM domain name.: string",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"resource": {
"type": "object"
},
"status": {
"type": "object"
}
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/deleteDomainNameCidrMapsMapName"
},
"task": true
},
{
"name": "getDomainNameDatacenters",
"summary": "List data centers: Returns a list of data centers.",
"description": "List data centers: Returns a list of data centers.",
"input": [
{
"name": "domainName",
"type": "string",
"info": "The full GTM domain name.: string",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDomainNameDatacenters"
},
"task": true
},
{
"name": "postDomainNameDatacenters",
"summary": "Create a data center: Creates a specific data center.",
"description": "Create a data center: Creates a specific data center.",
"input": [
{
"name": "domainName",
"type": "string",
"info": "The full GTM domain name.: string",
"required": true,
"schema": {
"title": "domainName",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"city\": \"string\", \"cloneOf\": 123, \"cloudServerTargeting\": \"boolean\", \"continent\": \"Must be one of [AF, AS, EU, NA, OC, OT, SA]\", \"country\": \"string\", \"datacenterId\": 123, \"defaultLoadObject\": {\"loadObject\": \"string\", \"loadObjectPort\": 123, \"loadServers\": \"array\"}, \"latitude\": 123, \"links\": \"array\", \"longitude\": 123, \"nickname\": \"string\", \"stateOrProvince\": \"string\", \"virtual\": \"boolean\"}",
"required": false,
"schema": {
"description": "Contains information about the data centers in the GTM domain.",
"type": "object",
"additionalProperties": false,
"properties": {
"city": {
"description": "The name of the city where the data center is located.",
"type": "string"
},
"cloneOf": {
"description": "Identifies the data center's `datacenterId` of which this data center is a clone. A data center clone is just like any other data center except that it inherits its geographic attributes (`continent`, `country`, `stateOrProvince`, `city`, `latitude`, and `longitude`) from the data center of which it is a clone.",
"type": "integer"
},
"cloudServerTargeting": {
"description": "Balances load between two or more servers in a cloud environment. Either `true` if cloud server targeting is enabled or `false` if not.",
"type": "boolean"
},
"continent": {
"maxLength": 2,
"description": "A two-letter code that specifies the continent where the data center maps to. If omitted, GTM populates this parameter. Either `AF`, `AS`, `EU`, `NA`, `OC`, `OT`, or `SA`. ",
"enum": [
"AF",
"AS",
"EU",
"NA",
"OC",
"OT",
"SA"
],
"type": "string"
},
"country": {
"maxLength": 2,
"description": "A two-letter [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) country code that specifies the country where the data center maps to.",
"type": "string"
},
"datacenterId": {
"description": "A unique identifier for