@itentialopensource/adapter-akamai_property_manager
Version:
This adapter integrates with the Akamai Property Manager API.
1,581 lines • 167 kB
JSON
{
"id": "@itentialopensource/adapter-akamai_property_manager",
"type": "Adapter",
"export": "AkamaiPropertyManager",
"title": "Akamai_property_manager",
"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"
}
}
],
"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": [
{
"name": "maxCalls",
"required": false,
"type": "number",
"info": "How many GET endpoints to test (defaults to 5)",
"schema": {
"title": "maxCalls",
"type": "number",
"default": 5
}
}
],
"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 Itential Platform database",
"description": "Moves entities from an adapter into the Itential Platform 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": "bulkactivateasetofproperties",
"summary": "Bulk activate a set of properties",
"description": "XXX Bulk activate a set of property versions.\n(Alternately, perform a bulk [fallback](doc:fast-validation) to the previous\nactivation within an hour of the previous bulk activation.)\nBase the set of versions to activate on the results of a\n[bulk patch](https://dash.readme.com/project/papi-akamai/v1/refs/get_bulk-rules-patch-requests-bulkpatchid)\noperation, which you use to create a\n[BulkActivation](#bulkactivation) POST object.\nThis operation launches an asynchronous process to update\nproperties...(description truncated)",
"input": [
{
"name": "contractId",
"type": "string",
"info": "Optionally filters bulk searches to properties provisioned\nunder the specified contract. For bulk operations, you can\nspecify `contractId` and `groupId` independently fro...(description truncated): string",
"required": true,
"schema": {
"title": "contractId",
"type": "string"
}
},
{
"name": "groupId",
"type": "string",
"info": "Optionally filters bulk searches to properties provisioned\nunder the specified group. For bulk operations, you can\nspecify `contractId` and `groupId` independently from e...(description truncated): string",
"required": true,
"schema": {
"title": "groupId",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"activatePropertyVersions\": [{\"network\": \"string\", \"note\": \"string\", \"propertyId\": \"string\", \"propertyVersion\": 123, \"notifyEmails\": \"array\", \"acknowledgeAllWarnings\": \"boolean\", \"acknowledgeWarnings\": \"array\"}], \"defaultActivationSettings\": {\"acknowledgeAllWarnings\": \"boolean\", \"fastPush\": \"boolean\", \"notifyEmails\": \"array\", \"useFastFallback\": \"boolean\"}}",
"required": true,
"schema": {
"title": "BulkactivateasetofpropertiesRequest",
"required": [
"activatePropertyVersions",
"defaultActivationSettings"
],
"type": "object",
"properties": {
"activatePropertyVersions": {
"type": "array",
"items": {
"title": "ActivatePropertyVersion",
"required": [
"network",
"note",
"propertyId",
"propertyVersion"
],
"type": "object",
"properties": {
"network": {
"type": "string"
},
"note": {
"type": "string"
},
"propertyId": {
"type": "string"
},
"propertyVersion": {
"type": "integer"
},
"notifyEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"acknowledgeAllWarnings": {
"type": "boolean"
},
"acknowledgeWarnings": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"example": {
"network": "STAGING",
"note": "Some activation note",
"propertyId": "prp_1",
"propertyVersion": 2
}
},
"description": ""
},
"defaultActivationSettings": {
"title": "DefaultActivationSettings",
"required": [
"acknowledgeAllWarnings",
"fastPush",
"notifyEmails",
"useFastFallback"
],
"type": "object",
"properties": {
"acknowledgeAllWarnings": {
"type": "boolean"
},
"fastPush": {
"type": "boolean"
},
"notifyEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"useFastFallback": {
"type": "boolean"
}
},
"example": {
"acknowledgeAllWarnings": true,
"fastPush": true,
"notifyEmails": [
"you@example.com",
"them@example.com"
],
"useFastFallback": false
}
}
},
"example": {
"activatePropertyVersions": [
{
"network": "STAGING",
"note": "Some activation note",
"propertyId": "prp_1",
"propertyVersion": 2
},
{
"network": "STAGING",
"note": "Sample activation",
"notifyEmails": [
"someoneElse@somewhere.com"
],
"propertyId": "prp_15",
"propertyVersion": 3
},
{
"acknowledgeAllWarnings": false,
"acknowledgeWarnings": [
"msg_123",
"msg_234"
],
"network": "PRODUCTION",
"note": "created by xyz",
"propertyId": "prp_3",
"propertyVersion": 11
}
],
"defaultActivationSettings": {
"acknowledgeAllWarnings": true,
"fastPush": true,
"notifyEmails": [
"you@example.com",
"them@example.com"
],
"useFastFallback": 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": "/bulkactivateasetofproperties"
},
"task": true
},
{
"name": "listbulkActivatedproperties",
"summary": "List bulk-activated properties",
"description": "List all activations that result from a [bulk activation request](https://papi-akamai.readme.io/reference/bulkactivations#post_bulk-activations), and poll the asynchronous process's status. Once the overall `bulkActivationStatus` is `COMPLETE`, check each activation's `activationStatus` to confirm it's `ACTIVATED`. The response is a [BulkActivation](#bulkactivation) GET object. See [Bulk Search and Update](doc:learn-about-bulk) for overall guidance on this feature.",
"input": [
{
"name": "contractId",
"type": "string",
"info": "Optionally filters bulk searches to properties provisioned\nunder the specified contract. For bulk operations, you can\nspecify `contractId` and `groupId` independently fro...(description truncated): string",
"required": true,
"schema": {
"title": "contractId",
"type": "string"
}
},
{
"name": "groupId",
"type": "string",
"info": "Optionally filters bulk searches to properties provisioned\nunder the specified group. For bulk operations, you can\nspecify `contractId` and `groupId` independently from e...(description truncated): string",
"required": true,
"schema": {
"title": "groupId",
"type": "string"
}
},
{
"name": "bulkActivationId",
"type": "string",
"info": "(Required) Identifies each bulk activation job.: string",
"required": true,
"schema": {
"title": "bulkActivationId",
"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": "/listbulkActivatedproperties"
},
"task": true
},
{
"name": "listactivations",
"summary": "List activations",
"description": "This lists all activations for all versions of a property, on both production and staging networks.",
"input": [
{
"name": "contractId",
"type": "string",
"info": "Unique identifier for the contract.\nThe parameter is optional if the property has been\nprovisioned under only one contract.\nOtherwise you need to specify it along with th...(description truncated): string",
"required": true,
"schema": {
"title": "contractId",
"type": "string"
}
},
{
"name": "groupId",
"type": "string",
"info": "Unique identifier for the group.\nThe parameter is optional if the property has been\nprovisioned under only one group.\nOtherwise you need to specify it along with the `con...(description truncated): string",
"required": true,
"schema": {
"title": "groupId",
"type": "string"
}
},
{
"name": "propertyId",
"type": "string",
"info": "(Required) Unique identifier for the property.\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `prp_` prefix.: string",
"required": true,
"schema": {
"title": "propertyId",
"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": "/listactivations"
},
"task": true
},
{
"name": "createanewactivationordeactivation",
"summary": "Create a new activation or deactivation",
"description": "This operation creates a new property activation, which\ndeactivates any current activation. After a necessary delay,\nthis activates your property version's rule tree and set of\nhostnames across Akamai's network of edge servers, modifying how\nyour edge content responds to end-user requests.\nIf there's a problem with the property you activated, you may\nhave the option to fall back to the previous version. Within an\nhour of activating, POSTing another activation with\n`\\\"useFastFallback\\\":true` in t...(description truncated)",
"input": [
{
"name": "contractId",
"type": "string",
"info": "Unique identifier for the contract.\nThe parameter is optional if the property has been\nprovisioned under only one contract.\nOtherwise you need to specify it along with th...(description truncated): string",
"required": true,
"schema": {
"title": "contractId",
"type": "string"
}
},
{
"name": "groupId",
"type": "string",
"info": "Unique identifier for the group.\nThe parameter is optional if the property has been\nprovisioned under only one group.\nOtherwise you need to specify it along with the `con...(description truncated): string",
"required": true,
"schema": {
"title": "groupId",
"type": "string"
}
},
{
"name": "propertyId",
"type": "string",
"info": "(Required) Unique identifier for the property.\nSee [ID prefixes](doc:id-prefixes)\nfor details on omitting the value's `prp_` prefix.: string",
"required": true,
"schema": {
"title": "propertyId",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"acknowledgeWarnings\": \"array\", \"network\": \"string\", \"note\": \"string\", \"notifyEmails\": \"array\", \"propertyVersion\": 123, \"useFastFallback\": \"boolean\"}",
"required": true,
"schema": {
"title": "CreateanewactivationordeactivationRequest",
"required": [
"acknowledgeWarnings",
"network",
"note",
"notifyEmails",
"propertyVersion",
"useFastFallback"
],
"type": "object",
"properties": {
"acknowledgeWarnings": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"network": {
"type": "string"
},
"note": {
"type": "string"
},
"notifyEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"propertyVersion": {
"type": "integer"
},
"useFastFallback": {
"type": "boolean"
}
},
"example": {
"acknowledgeWarnings": [
"msg_baa4560881774a45b5fd25f5b1eab021d7c40b4f"
],
"network": "STAGING",
"note": "Sample activation",
"notifyEmails": [
"you@example.com",
"them@example.com"
],
"propertyVersion": 1,
"useFastFallback": 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": "/createanewactivationordeactivation"
},
"task": true
},
{
"name": "bulkversionasetofproperties",
"summary": "Bulk version a set of properties",
"description": "POST a [BulkVersion](#bulkversion) object to create new\nversions of a set of properties based on any previous version.\nThis operation launches an asynchronous process to increment\nversions. To check its progress,\nrun the [List bulk-versioned properties](https://papi-akamai.readme.io/reference/bulkproperty-version-creationsbulkcreateid#get_bulk-property-version-creations-bulkcreateid)\noperation, whose link is available in the `Location` header or\n`bulkCreateVersionLink` member of this operation's...(description truncated)",
"input": [
{
"name": "contractId",
"type": "string",
"info": "Optionally filters bulk searches to properties provisioned\nunder the specified contract. For bulk operations, you can\nspecify `contractId` and `groupId` independently fro...(description truncated): string",
"required": true,
"schema": {
"title": "contractId",
"type": "string"
}
},
{
"name": "groupId",
"type": "string",
"info": "Optionally filters bulk searches to properties provisioned\nunder the specified group. For bulk operations, you can\nspecify `contractId` and `groupId` independently from e...(description truncated): string",
"required": true,
"schema": {
"title": "groupId",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"createPropertyVersions\": [{\"createFromVersion\": 123, \"createFromVersionEtag\": \"string\", \"propertyId\": \"string\"}]}",
"required": true,
"schema": {
"title": "BulkversionasetofpropertiesRequest",
"required": [
"createPropertyVersions"
],
"type": "object",
"properties": {
"createPropertyVersions": {
"type": "array",
"items": {
"title": "CreatePropertyVersion",
"required": [
"createFromVersion",
"createFromVersionEtag",
"propertyId"
],
"type": "object",
"properties": {
"createFromVersion": {
"type": "integer"
},
"createFromVersionEtag": {
"type": "string"
},
"propertyId": {
"type": "string"
}
},
"example": {
"createFromVersion": 1,
"createFromVersionEtag": "2641910c585cf67b",
"propertyId": "prp_1"
}
},
"description": ""
}
},
"example": {
"createPropertyVersions": [
{
"createFromVersion": 1,
"createFromVersionEtag": "2641910c585cf67b",
"propertyId": "prp_1"
},
{
"createFromVersion": 2,
"createFromVersionEtag": "343410c585cf67fc",
"propertyId": "prp_15"
},
{
"createFromVersion": 10,
"createFromVersionEtag": "6c7v5c65c6cvcv65",
"propertyId": "prp_3"
}
]
}
}
}
],
"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": "/bulkversionasetofproperties"
},
"task": true
},
{
"name": "listbulkVersionedproperties",
"summary": "List bulk-versioned properties",
"description": "List all new property versions that result from a [bulk versioning request](https://papi-akamai.readme.io/reference/bulkproperty-version-creations#post_bulk-property-version-creations), and poll the asynchronous process's status. The response is a [BulkVersion](#bulkversion) GET object. After the `bulkCreateVersionsStatus` is `COMPLETE`, use the new version numbers along with search paths from a [bulk search](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-searc...(description truncated)",
"input": [
{
"name": "contractId",
"type": "string",
"info": "Optionally filters bulk searches to properties provisioned\nunder the specified contract. For bulk operations, you can\nspecify `contractId` and `groupId` independently fro...(description truncated): string",
"required": true,
"schema": {
"title": "contractId",
"type": "string"
}
},
{
"name": "groupId",
"type": "string",
"info": "Optionally filters bulk searches to properties provisioned\nunder the specified group. For bulk operations, you can\nspecify `contractId` and `groupId` independently from e...(description truncated): string",
"required": true,
"schema": {
"title": "groupId",
"type": "string"
}
},
{
"name": "bulkCreateId",
"type": "string",
"info": "(Required) Identifies each bulk-versioning job.: string",
"required": true,
"schema": {
"title": "bulkCreateId",
"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": "/listbulkVersionedproperties"
},
"task": true
},
{
"name": "bulkpatchasetofproperties",
"summary": "Bulk patch a set of properties",
"description": "Apply a series of JSON Patch\noperations to modify a set of property versions. Form this set\nof `patches` based on the\n[JSONPath](http://goessner.net/articles/JsonPath/) locations\nfrom a [bulk search](https://papi-akamai.readme.io/reference/bulkrules-search-requests#post_bulk-rules-search-requests) response. Specify a set\nof new property versions based on the results of a\n[bulk versioning](https://papi-akamai.readme.io/reference/bulkproperty-version-creations#post_bulk-property-version-creations)...(description truncated)",
"input": [
{
"name": "contractId",
"type": "string",
"info": "Optionally filters bulk searches to properties provisioned\nunder the specified contract. For bulk operations, you can\nspecify `contractId` and `groupId` independently fro...(description truncated): string",
"required": true,
"schema": {
"title": "contractId",
"type": "string"
}
},
{
"name": "groupId",
"type": "string",
"info": "Optionally filters bulk searches to properties provisioned\nunder the specified group. For bulk operations,