{ "components": { "headers": { "location-header": { "description": "The unique identifier for the newly created resource. Append this ID to a subsequent GET call to view the resource details.", "schema": { "example": "/targets/1100", "format": "uri", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } }, "parameters": { "target-id-path": { "description": "The unique identifier for the target.", "in": "path", "name": "targetId", "required": true, "schema": { "example": "23", "type": "string" }, "x-akamai": { "file-path": "parameters/target-id-path.yaml" } } }, "responses": { "error-400": { "content": { "application/problem+json": { "example": { "detail": "The request contains invalid or malformed data", "instance": "/prolexic-network-health/v1/targets/21", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/prolexic-network-health/reference/400). The request is invalid and contains malformed data.", "x-akamai": { "file-path": "errors/error-400.yaml" } }, "error-404": { "content": { "application/problem+json": { "example": { "detail": "Target not found", "instance": "/prolexic-network-health/v1/targets/21", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Target not found](https://techdocs.akamai.com/prolexic-network-health/reference/404). The requested monitored target doesn't exist.", "x-akamai": { "file-path": "errors/error-404.yaml" } }, "error-409": { "content": { "application/problem+json": { "example": { "detail": "Target count limit exceeded for this account", "instance": "/prolexic-network-health/v1/targets/21", "status": 409, "title": "Conflict", "type": "conflict" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Target count limit exceeded](https://techdocs.akamai.com/prolexic-network-health/reference/409). Exceeds the maximum number of allowed monitored targets based on the tier configuration.", "x-akamai": { "file-path": "errors/error-409.yaml" } }, "error-500": { "content": { "application/problem+json": { "example": { "detail": "An unexpected error occurred while processing the request", "instance": "/prolexic-network-health/v1/targets/21", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/prolexic-network-health/reference/500). An unexpected error occurred.", "x-akamai": { "file-path": "errors/error-500.yaml" } } }, "schemas": { "create-target-response": { "additionalProperties": false, "description": "Target creation message.", "properties": { "message": { "description": "A message indicating the target creation status.", "type": "string" } }, "required": [ "message" ], "type": "object", "x-akamai": { "file-path": "schemas/create-target-response.yaml" } }, "get-targets-response": { "additionalProperties": true, "description": "All configured targets.", "properties": { "targets": { "description": "The configured targets.", "items": { "additionalProperties": false, "description": "Network monitoring targets.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "__Read-only__ The user who created the configuration.", "minLength": 1, "readOnly": true, "type": "string" }, "createdTime": { "description": "__Read-only__ ISO 8601 timestamp when the target was created.", "format": "date-time", "readOnly": true, "type": "string" }, "modifiedBy": { "description": "__Read-only__ The user who updated the configuration last.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedTime": { "description": "__Read-only__ ISO 8601 timestamp when the target was last updated.", "format": "date-time", "readOnly": true, "type": "string" }, "ports": { "description": "The TCP ports to monitor.", "items": { "maximum": 65535, "minimum": 1, "type": "integer" }, "minItems": 1, "type": "array" }, "targetDomain": { "description": "Domain name to monitor for `HTTP` test type. Specify `null` for TCP test type.", "minLength": 0, "nullable": true, "type": "string" }, "targetId": { "description": "__Read-only__ The target's unique ID. ", "readOnly": true, "type": "string" }, "targetIp": { "description": "Single IP Address, v4 /32 or v6 /128 for `TCP` test type. Specify `null` for HTTP test type.", "minLength": 0, "nullable": true, "type": "string" }, "targetName": { "description": "The target name. ", "minLength": 1, "type": "string" }, "testIds": { "description": "The test IDs used by the target.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "testType": { "description": "The traffic type to test, either `TCP` or `HTTP`.", "enum": [ "TCP", "HTTP" ], "type": "string" } }, "required": [ "accountId", "targetName", "testType", "ports" ], "type": "object", "x-akamai": { "file-path": "schemas/target.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-targets-response.yaml" } }, "problem": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } }, "target": { "additionalProperties": false, "description": "Network monitoring targets.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "__Read-only__ The user who created the configuration.", "minLength": 1, "readOnly": true, "type": "string" }, "createdTime": { "description": "__Read-only__ ISO 8601 timestamp when the target was created.", "format": "date-time", "readOnly": true, "type": "string" }, "modifiedBy": { "description": "__Read-only__ The user who updated the configuration last.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedTime": { "description": "__Read-only__ ISO 8601 timestamp when the target was last updated.", "format": "date-time", "readOnly": true, "type": "string" }, "ports": { "description": "The TCP ports to monitor.", "items": { "maximum": 65535, "minimum": 1, "type": "integer" }, "minItems": 1, "type": "array" }, "targetDomain": { "description": "Domain name to monitor for `HTTP` test type. Specify `null` for TCP test type.", "minLength": 0, "nullable": true, "type": "string" }, "targetId": { "description": "__Read-only__ The target's unique ID. ", "readOnly": true, "type": "string" }, "targetIp": { "description": "Single IP Address, v4 /32 or v6 /128 for `TCP` test type. Specify `null` for HTTP test type.", "minLength": 0, "nullable": true, "type": "string" }, "targetName": { "description": "The target name. ", "minLength": 1, "type": "string" }, "testIds": { "description": "The test IDs used by the target.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "testType": { "description": "The traffic type to test, either `TCP` or `HTTP`.", "enum": [ "TCP", "HTTP" ], "type": "string" } }, "required": [ "accountId", "targetName", "testType", "ports" ], "type": "object", "x-akamai": { "file-path": "schemas/target.yaml" } }, "target-request": { "additionalProperties": false, "description": "Network monitoring targets.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "ports": { "description": "The TCP ports to monitor.", "items": { "maximum": 65535, "minimum": 1, "type": "integer" }, "minItems": 1, "type": "array" }, "targetDomain": { "description": "The domain name to monitor for the `HTTP` test type. Specify `null` for the TCP test type.", "minLength": 1, "nullable": true, "type": "string" }, "targetIp": { "description": "Single IP Address, v4 /32 or v6 /128 for the `TCP` test type. Specify `null` for the `HTTP` test type.", "minLength": 1, "nullable": true, "type": "string" }, "targetName": { "description": "The target name.", "minLength": 1, "type": "string" }, "testIds": { "description": "The test IDs used by the target.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "testType": { "description": "The traffic type to test, either `TCP` or `HTTP`.", "enum": [ "TCP", "HTTP" ], "type": "string" } }, "required": [ "accountId", "targetName", "testType", "ports" ], "type": "object", "x-akamai": { "file-path": "schemas/target-request.yaml" } }, "target-response": { "additionalProperties": false, "description": "Target details.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "__Read-only__ The user who created the configuration.", "minLength": 1, "readOnly": true, "type": "string" }, "createdTime": { "description": "__Read-only__ ISO 8601 timestamp of the target's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "modifiedBy": { "description": "__Read-only__ The user who updated the configuration last.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedTime": { "description": "__Read-only__ ISO 8601 timestamp of the target's last update.", "format": "date-time", "readOnly": true, "type": "string" }, "ports": { "description": "The TCP ports to monitor.", "items": { "maximum": 65535, "minimum": 1, "type": "integer" }, "minItems": 1, "type": "array" }, "targetDomain": { "description": "Domain name to monitor for `HTTP` test type. Specify `null` for TCP test type.", "minLength": 0, "nullable": true, "type": "string" }, "targetId": { "description": "__Read-only__ The target's unique identifier.", "readOnly": true, "type": "string" }, "targetIp": { "description": "Single IP Address, v4 /32 or v6 /128 for `TCP` test type. Specify `null` for HTTP test type.", "minLength": 0, "nullable": true, "type": "string" }, "targetName": { "description": "The target name.", "minLength": 1, "type": "string" }, "testIds": { "description": "The test IDs used by the target.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "testType": { "description": "The traffic type to test, either `TCP` or `HTTP`.", "enum": [ "TCP", "HTTP" ], "type": "string" } }, "required": [ "accountId", "targetName", "testType", "ports" ], "type": "object", "x-akamai": { "file-path": "schemas/target-response.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's Prolexic Network Health API", "url": "https://techdocs.akamai.com/prolexic-network-health/reference" }, "info": { "description": "Prolexic Network Health provides network traffic visibility through Akamai's network to diagnose network issues without relying solely on third-party tools\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Prolexic Network Health API", "version": "v1" }, "openapi": "3.0.3", "paths": { "/targets": { "post": { "description": "Add a new target with validation for tier limits.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Health API", "url": "https://techdocs.akamai.com/prolexic-network-health/reference/post-create-target" }, "operationId": "post-create-target", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "accountId": "A-CCT7890", "ports": [ 80, 443, 8080 ], "targetDomain": "api.example.com", "targetIp": "192.168.1.100", "targetName": "Production Web Server", "testIds": [ 1, 3, 5 ], "testType": "HTTP" }, "schema": { "additionalProperties": false, "description": "Network monitoring targets.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "ports": { "description": "The TCP ports to monitor.", "items": { "maximum": 65535, "minimum": 1, "type": "integer" }, "minItems": 1, "type": "array" }, "targetDomain": { "description": "The domain name to monitor for the `HTTP` test type. Specify `null` for the TCP test type.", "minLength": 1, "nullable": true, "type": "string" }, "targetIp": { "description": "Single IP Address, v4 /32 or v6 /128 for the `TCP` test type. Specify `null` for the `HTTP` test type.", "minLength": 1, "nullable": true, "type": "string" }, "targetName": { "description": "The target name.", "minLength": 1, "type": "string" }, "testIds": { "description": "The test IDs used by the target.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "testType": { "description": "The traffic type to test, either `TCP` or `HTTP`.", "enum": [ "TCP", "HTTP" ], "type": "string" } }, "required": [ "accountId", "targetName", "testType", "ports" ], "type": "object", "x-akamai": { "file-path": "schemas/target-request.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "message": "Target created" }, "schema": { "additionalProperties": false, "description": "Target creation message.", "properties": { "message": { "description": "A message indicating the target creation status.", "type": "string" } }, "required": [ "message" ], "type": "object", "x-akamai": { "file-path": "schemas/create-target-response.yaml" } } } }, "description": "Target created successfully.", "headers": { "Location": { "description": "The unique identifier for the newly created resource. Append this ID to a subsequent GET call to view the resource details.", "schema": { "example": "/targets/1100", "format": "uri", "type": "string" }, "x-akamai": { "file-path": "headers/location-header.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "The request contains invalid or malformed data", "instance": "/prolexic-network-health/v1/targets/21", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/prolexic-network-health/reference/400). The request is invalid and contains malformed data.", "x-akamai": { "file-path": "errors/error-400.yaml" } }, "409": { "content": { "application/problem+json": { "example": { "detail": "Target count limit exceeded for this account", "instance": "/prolexic-network-health/v1/targets/21", "status": 409, "title": "Conflict", "type": "conflict" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Target count limit exceeded](https://techdocs.akamai.com/prolexic-network-health/reference/409). Exceeds the maximum number of allowed monitored targets based on the tier configuration.", "x-akamai": { "file-path": "errors/error-409.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "An unexpected error occurred while processing the request", "instance": "/prolexic-network-health/v1/targets/21", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/prolexic-network-health/reference/500). An unexpected error occurred.", "x-akamai": { "file-path": "errors/error-500.yaml" } } }, "summary": "Create a new target", "tags": [ "Targets" ] }, "get": { "description": "Retrieve all targets.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Health API", "url": "https://techdocs.akamai.com/prolexic-network-health/reference/get-all-targets" }, "operationId": "get-all-targets", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "targets": [ { "accountId": "A-CCT1234", "createdBy": "admin-001", "createdTime": "2025-08-08T15:44:36Z", "modifiedBy": "admin-002", "modifiedTime": "2025-08-19T07:45:48Z", "ports": [ 80, 81 ], "targetDomain": "", "targetId": "20", "targetIp": "172.26.119.222", "targetName": "west-tcp", "testIds": [ 3 ], "testType": "TCP" } ] }, "schema": { "additionalProperties": true, "description": "All configured targets.", "properties": { "targets": { "description": "The configured targets.", "items": { "additionalProperties": false, "description": "Network monitoring targets.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "__Read-only__ The user who created the configuration.", "minLength": 1, "readOnly": true, "type": "string" }, "createdTime": { "description": "__Read-only__ ISO 8601 timestamp when the target was created.", "format": "date-time", "readOnly": true, "type": "string" }, "modifiedBy": { "description": "__Read-only__ The user who updated the configuration last.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedTime": { "description": "__Read-only__ ISO 8601 timestamp when the target was last updated.", "format": "date-time", "readOnly": true, "type": "string" }, "ports": { "description": "The TCP ports to monitor.", "items": { "maximum": 65535, "minimum": 1, "type": "integer" }, "minItems": 1, "type": "array" }, "targetDomain": { "description": "Domain name to monitor for `HTTP` test type. Specify `null` for TCP test type.", "minLength": 0, "nullable": true, "type": "string" }, "targetId": { "description": "__Read-only__ The target's unique ID. ", "readOnly": true, "type": "string" }, "targetIp": { "description": "Single IP Address, v4 /32 or v6 /128 for `TCP` test type. Specify `null` for HTTP test type.", "minLength": 0, "nullable": true, "type": "string" }, "targetName": { "description": "The target name. ", "minLength": 1, "type": "string" }, "testIds": { "description": "The test IDs used by the target.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "testType": { "description": "The traffic type to test, either `TCP` or `HTTP`.", "enum": [ "TCP", "HTTP" ], "type": "string" } }, "required": [ "accountId", "targetName", "testType", "ports" ], "type": "object", "x-akamai": { "file-path": "schemas/target.yaml" } }, "type": "array" } }, "type": "object", "x-akamai": { "file-path": "schemas/get-targets-response.yaml" } } } }, "description": "List of all targets." }, "400": { "content": { "application/problem+json": { "example": { "detail": "The request contains invalid or malformed data", "instance": "/prolexic-network-health/v1/targets/21", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/prolexic-network-health/reference/400). The request is invalid and contains malformed data.", "x-akamai": { "file-path": "errors/error-400.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "An unexpected error occurred while processing the request", "instance": "/prolexic-network-health/v1/targets/21", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/prolexic-network-health/reference/500). An unexpected error occurred.", "x-akamai": { "file-path": "errors/error-500.yaml" } } }, "summary": "List targets", "tags": [ "Targets" ] }, "x-akamai": { "file-path": "paths/targets.yaml", "path-info": "/targets" } }, "/targets/{targetId}": { "get": { "description": "Retrieve target details by target ID.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Health API", "url": "https://techdocs.akamai.com/prolexic-network-health/reference/get-target-by-id" }, "operationId": "get-target-by-id", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "accountId": "A-CCT7890", "createdBy": "asingh", "createdTime": "2025-07-18T12:34:56Z", "modifiedBy": "alfulani", "modifiedTime": "2025-07-18T13:45:00Z", "ports": [ 80, 443, 8080 ], "targetDomain": "api.example.com", "targetId": "789", "targetIp": "192.168.1.100", "targetName": "Production Web Server", "testIds": [ 1, 3, 5 ], "testType": "HTTP" }, "schema": { "additionalProperties": false, "description": "Target details.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "__Read-only__ The user who created the configuration.", "minLength": 1, "readOnly": true, "type": "string" }, "createdTime": { "description": "__Read-only__ ISO 8601 timestamp of the target's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "modifiedBy": { "description": "__Read-only__ The user who updated the configuration last.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedTime": { "description": "__Read-only__ ISO 8601 timestamp of the target's last update.", "format": "date-time", "readOnly": true, "type": "string" }, "ports": { "description": "The TCP ports to monitor.", "items": { "maximum": 65535, "minimum": 1, "type": "integer" }, "minItems": 1, "type": "array" }, "targetDomain": { "description": "Domain name to monitor for `HTTP` test type. Specify `null` for TCP test type.", "minLength": 0, "nullable": true, "type": "string" }, "targetId": { "description": "__Read-only__ The target's unique identifier.", "readOnly": true, "type": "string" }, "targetIp": { "description": "Single IP Address, v4 /32 or v6 /128 for `TCP` test type. Specify `null` for HTTP test type.", "minLength": 0, "nullable": true, "type": "string" }, "targetName": { "description": "The target name.", "minLength": 1, "type": "string" }, "testIds": { "description": "The test IDs used by the target.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "testType": { "description": "The traffic type to test, either `TCP` or `HTTP`.", "enum": [ "TCP", "HTTP" ], "type": "string" } }, "required": [ "accountId", "targetName", "testType", "ports" ], "type": "object", "x-akamai": { "file-path": "schemas/target-response.yaml" } } } }, "description": "Target data." }, "404": { "content": { "application/problem+json": { "example": { "detail": "Target not found", "instance": "/prolexic-network-health/v1/targets/21", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Target not found](https://techdocs.akamai.com/prolexic-network-health/reference/404). The requested monitored target doesn't exist.", "x-akamai": { "file-path": "errors/error-404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "An unexpected error occurred while processing the request", "instance": "/prolexic-network-health/v1/targets/21", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/prolexic-network-health/reference/500). An unexpected error occurred.", "x-akamai": { "file-path": "errors/error-500.yaml" } } }, "summary": "Get target by ID", "tags": [ "Targets" ] }, "put": { "description": "Updates a target.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Health API", "url": "https://techdocs.akamai.com/prolexic-network-health/reference/put-update-target" }, "operationId": "put-update-target", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "accountId": "A-CCT7890", "ports": [ 80, 443, 8080 ], "targetDomain": "api.example.com", "targetIp": "192.168.1.100", "targetName": "Production Web Server", "testIds": [ 1, 3, 5 ], "testType": "HTTP" }, "schema": { "additionalProperties": false, "description": "Network monitoring targets.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "ports": { "description": "The TCP ports to monitor.", "items": { "maximum": 65535, "minimum": 1, "type": "integer" }, "minItems": 1, "type": "array" }, "targetDomain": { "description": "The domain name to monitor for the `HTTP` test type. Specify `null` for the TCP test type.", "minLength": 1, "nullable": true, "type": "string" }, "targetIp": { "description": "Single IP Address, v4 /32 or v6 /128 for the `TCP` test type. Specify `null` for the `HTTP` test type.", "minLength": 1, "nullable": true, "type": "string" }, "targetName": { "description": "The target name.", "minLength": 1, "type": "string" }, "testIds": { "description": "The test IDs used by the target.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "testType": { "description": "The traffic type to test, either `TCP` or `HTTP`.", "enum": [ "TCP", "HTTP" ], "type": "string" } }, "required": [ "accountId", "targetName", "testType", "ports" ], "type": "object", "x-akamai": { "file-path": "schemas/target-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "accountId": "A-CCT7890", "createdBy": "asingh", "createdTime": "2025-07-18T12:34:56Z", "modifiedBy": "alfulani", "modifiedTime": "2025-07-18T13:45:00Z", "ports": [ 80, 443, 8080 ], "targetDomain": "api.example.com", "targetId": "789", "targetIp": "192.168.1.100", "targetName": "Production Web Server", "testIds": [ 1, 3, 5 ], "testType": "HTTP" }, "schema": { "additionalProperties": false, "description": "Target details.", "properties": { "accountId": { "description": "The account ID.", "minLength": 1, "type": "string" }, "createdBy": { "description": "__Read-only__ The user who created the configuration.", "minLength": 1, "readOnly": true, "type": "string" }, "createdTime": { "description": "__Read-only__ ISO 8601 timestamp of the target's creation.", "format": "date-time", "readOnly": true, "type": "string" }, "modifiedBy": { "description": "__Read-only__ The user who updated the configuration last.", "minLength": 1, "readOnly": true, "type": "string" }, "modifiedTime": { "description": "__Read-only__ ISO 8601 timestamp of the target's last update.", "format": "date-time", "readOnly": true, "type": "string" }, "ports": { "description": "The TCP ports to monitor.", "items": { "maximum": 65535, "minimum": 1, "type": "integer" }, "minItems": 1, "type": "array" }, "targetDomain": { "description": "Domain name to monitor for `HTTP` test type. Specify `null` for TCP test type.", "minLength": 0, "nullable": true, "type": "string" }, "targetId": { "description": "__Read-only__ The target's unique identifier.", "readOnly": true, "type": "string" }, "targetIp": { "description": "Single IP Address, v4 /32 or v6 /128 for `TCP` test type. Specify `null` for HTTP test type.", "minLength": 0, "nullable": true, "type": "string" }, "targetName": { "description": "The target name.", "minLength": 1, "type": "string" }, "testIds": { "description": "The test IDs used by the target.", "items": { "minimum": 1, "type": "integer" }, "minItems": 0, "type": "array" }, "testType": { "description": "The traffic type to test, either `TCP` or `HTTP`.", "enum": [ "TCP", "HTTP" ], "type": "string" } }, "required": [ "accountId", "targetName", "testType", "ports" ], "type": "object", "x-akamai": { "file-path": "schemas/target-response.yaml" } } } }, "description": "Target updated successfully." }, "400": { "content": { "application/problem+json": { "example": { "detail": "The request contains invalid or malformed data", "instance": "/prolexic-network-health/v1/targets/21", "status": 400, "title": "Bad Request", "type": "bad_request" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/prolexic-network-health/reference/400). The request is invalid and contains malformed data.", "x-akamai": { "file-path": "errors/error-400.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Target not found", "instance": "/prolexic-network-health/v1/targets/21", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Target not found](https://techdocs.akamai.com/prolexic-network-health/reference/404). The requested monitored target doesn't exist.", "x-akamai": { "file-path": "errors/error-404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "An unexpected error occurred while processing the request", "instance": "/prolexic-network-health/v1/targets/21", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/prolexic-network-health/reference/500). An unexpected error occurred.", "x-akamai": { "file-path": "errors/error-500.yaml" } } }, "summary": "Update a target", "tags": [ "Targets" ] }, "delete": { "description": "Remove a target by target ID.", "externalDocs": { "description": "See documentation for this operation in Akamai's Prolexic Network Health API", "url": "https://techdocs.akamai.com/prolexic-network-health/reference/delete-target" }, "operationId": "delete-target", "parameters": [ { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Target deleted." }, "404": { "content": { "application/problem+json": { "example": { "detail": "Target not found", "instance": "/prolexic-network-health/v1/targets/21", "status": 404, "title": "Not Found", "type": "not_found" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Target not found](https://techdocs.akamai.com/prolexic-network-health/reference/404). The requested monitored target doesn't exist.", "x-akamai": { "file-path": "errors/error-404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "An unexpected error occurred while processing the request", "instance": "/prolexic-network-health/v1/targets/21", "status": 500, "title": "Internal Server Error", "type": "internal_server_error" }, "schema": { "additionalProperties": true, "description": "Simple error response with status and detail.", "properties": { "detail": { "description": "A human-readable explanation of the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "A URI that identifies the specific occurrence of the problem.", "type": "string" }, "status": { "description": "The HTTP status code.", "maximum": 599, "minimum": 100, "type": "integer" }, "title": { "description": "Short, human-readable summary of the problem type.", "type": "string" }, "type": { "description": "Identifies each problem type.", "type": "string" } }, "required": [ "type", "title", "status", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/prolexic-network-health/reference/500). An unexpected error occurred.", "x-akamai": { "file-path": "errors/error-500.yaml" } } }, "summary": "Delete a target", "tags": [ "Targets" ] }, "parameters": [ { "description": "The unique identifier for the target.", "in": "path", "name": "targetId", "required": true, "schema": { "example": "23", "type": "string" }, "x-akamai": { "file-path": "parameters/target-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/targets-id.yaml", "path-info": "/targets/{targetId}" } } }, "servers": [ { "url": "https://{hostname}/prolexic-network-health/v1" }, { "url": "http://prolexic-network-health/v1" } ], "tags": [ { "description": "Manage network targets for monitoring and health checks.", "name": "Targets" } ], "x-readme": { "explorer-enabled": false, "samples-languages": [ "curl", "python", "node" ] } }