Akamai API icon

Akamai API

Interact with Akamai APIs

Actions5

GET Request

AI-generated

Overview

This node enables making authenticated HTTP requests to Akamai APIs using the Akamai EdgeGrid authentication method. It supports all common HTTP methods (GET, POST, PUT, PATCH, DELETE) and allows flexible configuration of the API endpoint path, query parameters, headers, and request body.

A typical use case is automating interactions with Akamai services such as identity management, content delivery, or security configurations by programmatically calling their REST APIs. For example, you can retrieve user profile information, update configurations, or delete resources on Akamai via this node.

The "GET Request" operation specifically performs a GET HTTP request to a specified Akamai API endpoint, optionally including query parameters and custom headers, and returns the response data.

Properties

Name Meaning
API Path The relative path of the Akamai API endpoint to call. Must start with a slash (e.g., /identity-management/v3/user-profile).
PAPI Use Prefixes Controls whether to override the client's default setting for ID prefixes in responses (such as prp_, ctr_, grp_). Options: Don't send header, Include prefixes (true), Remove prefixes (false).
Return Full Response If enabled, returns an object containing both metadata (meta) about the response (status code, headers, endpoint) and the actual response data (data). Otherwise, only the response body is returned.
Options A collection of additional options:
- Query Parameters: Key-value pairs to be sent as URL query parameters.
- Headers: Custom HTTP headers to include in the request (e.g., Content-Language: en-US).

Output

The node outputs JSON data representing the response from the Akamai API:

  • By default, the output contains the parsed JSON response body.
  • If "Return Full Response" is enabled, the output is an object with two fields:
    • meta: Metadata about the response including HTTP status code, headers, and the endpoint called.
    • data: The actual response body data.

The node does not output binary data.

Example output when "Return Full Response" is false:

{
  "userId": "12345",
  "name": "John Doe",
  "email": "john.doe@example.com"
}

Example output when "Return Full Response" is true:

{
  "meta": {
    "statusCode": 200,
    "endpoint": "GET /identity-management/v3/user-profile",
    "headers": {
      "content-type": "application/json"
    }
  },
  "data": {
    "userId": "12345",
    "name": "John Doe",
    "email": "john.doe@example.com"
  }
}

Dependencies

  • Requires an Akamai API credential configured with the necessary tokens and host information to authenticate requests.
  • Uses the akamai-edgegrid npm package internally to handle authentication and request signing.
  • The node expects the Akamai API host URL to be provided in the credentials.
  • No additional environment variables are required beyond the credential setup.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect API path or method may result in 404 Not Found or 405 Method Not Allowed errors.
    • Malformed query parameters or headers can lead to unexpected API errors.
    • If the response cannot be parsed as JSON, an error indicating "Failed to parse response" will appear.

  • Error messages:

    • "Failed to parse response": The API returned a non-JSON or malformed response. Check the API endpoint and ensure it returns JSON.
    • HTTP status codes other than 2xx indicate API errors; inspect the meta field if full response is enabled.
    • Network or connection errors usually indicate credential misconfiguration or network issues.

  • How to resolve:

    • Verify that the API credentials are correct and have sufficient permissions.
    • Double-check the API path and HTTP method.
    • Ensure query parameters and headers are correctly formatted.
    • Enable "Return Full Response" to get detailed error info for debugging.

Links and References

Discussion