@itentialopensource/adapter-akamai_gtm

{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/domains/{domainName}/as-maps": { "get": { "tags": [ "AutonomousSystemMaps" ], "operationId": "getDomainNameAsMaps", "description": "The parameters and request body are for method: getDomainNameAsMaps. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "title": "domainName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/domains/{domainName}/as-maps/{mapName}": { "get": { "tags": [ "AutonomousSystemMaps" ], "operationId": "getDomainNameAsMapsMapName", "description": "The parameters and request body are for method: getDomainNameAsMapsMapName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "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" ] } } } } }, "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "title": "domainName", "type": "string" } }, { "name": "mapName", "in": "path", "required": true, "schema": { "title": "mapName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "AutonomousSystemMaps" ], "operationId": "putDomainNameAsMapsMapName", "description": "The parameters and request body are for method: putDomainNameAsMapsMapName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "string" } } } } }, "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "title": "domainName", "type": "string" } }, { "name": "mapName", "in": "path", "required": true, "schema": { "title": "mapName", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "AutonomousSystemMaps" ], "operationId": "deleteDomainNameAsMapsMapName", "description": "The parameters and request body are for method: deleteDomainNameAsMapsMapName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "string" } } } } }, "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "title": "domainName", "type": "string" } }, { "name": "mapName", "in": "path", "required": true, "schema": { "title": "mapName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/domains/{domainName}/cidr-maps": { "get": { "tags": [ "CIDRMaps" ], "operationId": "getDomainNameCidrMaps", "description": "The parameters and request body are for method: getDomainNameCidrMaps. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "defaultDatacenter": { "type": "object", "properties": { "datacenterId": { "type": "number" }, "nickname": { "type": "string" } } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "datacenterId": { "type": "number" }, "nickname": { "type": "string" }, "blocks": { "type": "array", "items": { "type": "string" } } } } }, "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" } } } } } } } } }, "example": { "items": [ { "name": "The North", "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "assignments": [ { "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men", "blocks": [ "1.2.3.0/24" ] }, { "datacenterId": 3133, "nickname": "Winterfell", "blocks": [ "1.2.4.0/24" ] } ], "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%20North", "rel": "self" } ] } ] } } } } }, "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "title": "domainName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/domains/{domainName}/cidr-maps/{mapName}": { "get": { "tags": [ "CIDRMaps" ], "operationId": "getDomainNameCidrMapsMapName", "description": "The parameters and request body are for method: getDomainNameCidrMapsMapName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "title": "domainName", "type": "string" } }, { "name": "mapName", "in": "path", "required": true, "schema": { "title": "mapName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "CIDRMaps" ], "operationId": "putDomainNameCidrMapsMapName", "description": "The parameters and request body are for method: putDomainNameCidrMapsMapName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "resource": { "type": "object", "properties": { "name": { "type": "string" }, "defaultDatacenter": { "type": "object", "properties": { "datacenterId": { "type": "number" }, "nickname": { "type": "string" } } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "datacenterId": { "type": "number" }, "nickname": { "type": "string" }, "blocks": { "type": "array", "items": { "type": "string" } } } } }, "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" } } } } } }, "status": { "type": "object", "properties": { "changeId": { "type": "string" }, "message": { "type": "string" }, "passingValidation": { "type": "boolean" }, "propagationStatus": { "type": "string" }, "propagationStatusDate": { "type": "string" }, "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" } } } } } } } }, "example": { "resource": { "name": "The North", "defaultDatacenter": { "datacenterId": 5400, "nickname": "All Other CIDR Blocks" }, "assignments": [ { "datacenterId": 3134, "nickname": "Frostfangs and the Fist of First Men", "blocks": [ "1.3.5.9", "1.2.3.0/24" ] }, { "datacenterId": 3133, "nickname": "Winterfell", "blocks": [ "1.2.4.0/24" ] } ], "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/cidr-maps/The%2520North", "rel": "self" } ] }, "status": { "changeId": "93a48b86-4fc3-4a5f-9ca2-036835034cc6", "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ] } } } } } }, "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "title": "domainName", "type": "string" } }, { "name": "mapName", "in": "path", "required": true, "schema": { "title": "mapName", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "CIDRMaps" ], "operationId": "deleteDomainNameCidrMapsMapName", "description": "The parameters and request body are for method: deleteDomainNameCidrMapsMapName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "resource": { "type": "object" }, "status": { "type": "object", "properties": { "changeId": { "type": "string" }, "message": { "type": "string" }, "passingValidation": { "type": "boolean" }, "propagationStatus": { "type": "string" }, "propagationStatusDate": { "type": "string" }, "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" } } } } } } } }, "example": { "resource": null, "status": { "changeId": "5beb11ae-8908-4bfe-8459-e88efc4d2fdc", "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-08T18:25:51.000+0000", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ] } } } } } }, "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "title": "domainName", "type": "string" } }, { "name": "mapName", "in": "path", "required": true, "schema": { "title": "mapName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/domains/{domainName}/datacenters": { "get": { "tags": [ "DataCenters" ], "operationId": "getDomainNameDatacenters", "description": "The parameters and request body are for method: getDomainNameDatacenters. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string" }, "cloneOf": { "type": "number" }, "continent": { "type": "string" }, "country": { "type": "string" }, "datacenterId": { "type": "number" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "nickname": { "type": "string" }, "stateOrProvince": { "type": "string" }, "virtual": { "type": "boolean" }, "defaultLoadObject": { "type": "object", "properties": { "loadObject": { "type": "object" }, "loadObjectPort": { "type": "number" }, "loadServers": { "type": "object" } } }, "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" } } } } } } } } }, "example": { "items": [ { "city": "Doune", "cloneOf": 0, "continent": "EU", "country": "GB", "datacenterId": 3133, "latitude": 56.185097, "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire", "virtual": true, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ] }, { "city": "Snæfellsjökull", "cloneOf": 0, "continent": "EU", "country": "IS", "datacenterId": 3134, "latitude": 64.808, "longitude": -23.776, "nickname": "Frostfangs", "stateOrProvince": null, "virtual": true, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3134", "rel": "self" } ] } ] } } } } }, "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "title": "domainName", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "DataCenters" ], "operationId": "postDomainNameDatacenters", "description": "The parameters and request body are for method: postDomainNameDatacenters. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "resource": { "type": "object", "properties": { "city": { "type": "string" }, "cloneOf": { "type": "number" }, "continent": { "type": "string" }, "country": { "type": "string" }, "datacenterId": { "type": "number" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "nickname": { "type": "string" }, "stateOrProvince": { "type": "string" }, "virtual": { "type": "boolean" }, "defaultLoadObject": { "type": "object", "properties": { "loadObject": { "type": "object" }, "loadObjectPort": { "type": "number" }, "loadServers": { "type": "object" } } }, "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" } } } } } }, "status": { "type": "object", "properties": { "changeId": { "type": "string" }, "message": { "type": "string" }, "passingValidation": { "type": "boolean" }, "propagationStatus": { "type": "string" }, "propagationStatusDate": { "type": "string" }, "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" } } } } } } } }, "example": { "resource": { "city": "Doune", "cloneOf": 0, "continent": "EU", "country": "GB", "datacenterId": 3133, "latitude": 56.185097, "longitude": -4.050264, "nickname": "Winterfell", "stateOrProvince": "Perthshire", "virtual": true, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ] }, "status": { "changeId": "f0c51967-d119-4665-9403-364a57ea5530", "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ] } } } } } }, "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "title": "domainName", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/domains/{domainName}/datacenters/{datacenterId}": { "get": { "tags": [ "DataCenters" ], "operationId": "getDomainNameDatacentersDatacenterId", "description": "The parameters and request body are for method: getDomainNameDatacentersDatacenterId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "city": { "type": "string" }, "cloneOf": { "type": "number" }, "continent": { "type": "string" }, "country": { "type": "string" }, "datacenterId": { "type": "number" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "nickname": { "type": "string" }, "stateOrProvince": { "type": "object" }, "virtual": { "type": "boolean" }, "defaultLoadObject": { "type": "object", "properties": { "loadObject": { "type": "object" }, "loadObjectPort": { "type": "number" }, "loadServers": { "type": "object" } } }, "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" } } } } } }, "example": { "city": "Downpatrick", "cloneOf": 0, "continent": "EU", "country": "GB", "datacenterId": 3133, "latitude": 54.367, "longitude": -5.582, "nickname": "Winterfell", "stateOrProvince": null, "virtual": true, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ] } } } } }, "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "title": "domainName", "type": "string" } }, { "name": "datacenterId", "in": "path", "required": true, "schema": { "title": "datacenterId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "DataCenters" ], "operationId": "putDomainNameDatacentersDatacenterId", "description": "The parameters and request body are for method: putDomainNameDatacentersDatacenterId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "resource": { "type": "object", "properties": { "city": { "type": "string" }, "cloneOf": { "type": "number" }, "continent": { "type": "string" }, "country": { "type": "string" }, "datacenterId": { "type": "number" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "nickname": { "type": "string" }, "stateOrProvince": { "type": "object" }, "virtual": { "type": "boolean" }, "defaultLoadObject": { "type": "object", "properties": { "loadObject": { "type": "object" }, "loadObjectPort": { "type": "number" }, "loadServers": { "type": "object" } } }, "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" } } } } } }, "status": { "type": "object", "properties": { "changeId": { "type": "string" }, "message": { "type": "string" }, "passingValidation": { "type": "boolean" }, "propagationStatus": { "type": "string" }, "propagationStatusDate": { "type": "string" }, "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" } } } } } } } }, "example": { "resource": { "city": "Downpatrick", "cloneOf": 0, "continent": "EU", "country": "GB", "datacenterId": 3133, "latitude": 54.367, "longitude": -5.582, "nickname": "Winterfell", "stateOrProvince": null, "virtual": true, "defaultLoadObject": { "loadObject": null, "loadObjectPort": 0, "loadServers": null }, "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/datacenters/3133", "rel": "self" } ] }, "status": { "changeId": "bd69be9b-ff44-433d-bff8-ae00d270ea33", "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-15T11:30:27.000+0000", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ] } } } } } }, "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "title": "domainName", "type": "string" } }, { "name": "datacenterId", "in": "path", "required": true, "schema": { "title": "datacenterId", "type": "number" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "delete": { "tags": [ "DataCenters" ], "operationId": "deleteDomainNameDatacentersDatacenterId", "description": "The parameters and request body are for method: deleteDomainNameDatacentersDatacenterId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "resource": { "type": "object" }, "status": { "type": "object", "properties": { "changeId": { "type": "string" }, "message": { "type": "string" }, "passingValidation": { "type": "boolean" }, "propagationStatus": { "type": "string" }, "propagationStatusDate": { "type": "string" }, "links": { "type": "array", "items": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" } } } } } } } }, "example": { "resource": null, "status": { "changeId": "66c7ff0b-4b9e-41cc-9fd0-34d4f75c2484", "message": "Change Pending", "passingValidation": true, "propagationStatus": "PENDING", "propagationStatusDate": "2014-04-03T21:18:01.000+0000", "links": [ { "href": "/config-gtm/v1/domains/example.akadns.net/status/current", "rel": "self" } ] } } } } } }, "parameters": [ { "name": "domainName", "in": "path", "required": true, "schema": { "title": "domainName", "type": "string" } }, { "name": "datacenterId", "in": "path", "required": true, "schema": { "title": "datacenterId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "objec