Akamai API icon

Akamai API

Interact with Akamai APIs

Actions5

POST Request

AI-generated

Overview

This node allows users to interact with Akamai APIs by making HTTP requests authenticated via Akamai EdgeGrid. Specifically, the "POST Request" operation sends a POST request to a specified Akamai API endpoint with a customizable JSON body and optional query parameters and headers.

Common scenarios include:

  • Creating or updating resources on Akamai services that require POST requests.
  • Automating configuration changes or data submissions to Akamai's identity management or other APIs.
  • Integrating Akamai API calls into workflows for content delivery, security, or user profile management.

For example, you might use this node to post user profile updates to Akamai's Identity Management API at /identity-management/v3/user-profile with a JSON payload describing the new user data.

Properties

Name Meaning
API Path The endpoint path of the Akamai API to which the POST request is sent (e.g., /identity-management/v3/user-profile).
Request Body The JSON-formatted body of the POST request containing the data to send.
PAPI Use Prefixes Controls whether to override the client's default setting for ID prefixes in responses (prp_, ctr_, grp_, etc.). Options: Don't Send Header, Include Prefixes (True), Remove Prefixes (False). Leave empty to use client default.
Return Full Response Boolean flag indicating whether to return the full response object including metadata ({ meta, data }) or just the response body.
Options Additional options including:
- Query Parameters Key-value pairs to be appended as query string parameters to the request URL.
- Headers Custom headers to include in the request, e.g., Content-Language: en-US.

Output

The node outputs an array of items where each item contains a json field representing the response from the Akamai API call.

  • If Return Full Response is false (default), the output json contains only the parsed response body from the API.
  • If Return Full Response is true, the output json contains an object with two properties:
    • meta: Metadata about the response such as HTTP status code, endpoint called, and response headers.
    • data: The actual response body returned by the API.

The node does not output binary data.

Dependencies

  • Requires an Akamai EdgeGrid API credential with valid clientToken, clientSecret, accessToken, and host.
  • Uses the akamai-edgegrid npm package to handle authentication and request signing.
  • The host URL must start with http or else https:// is prepended automatically.
  • No additional environment variables are required beyond the configured credentials.

Troubleshooting

  • Invalid Credentials or Authentication Errors: Ensure the API credentials are correctly configured and have sufficient permissions.
  • Malformed JSON Body: The request body must be valid JSON. If input is a string, it is parsed; invalid JSON will cause errors.
  • Missing Leading Slash in API Path: The node automatically adds a leading slash if missing, but ensure the path is correct.
  • Unexpected Response Parsing Errors: If the response cannot be parsed as JSON, the node returns an error with raw response included.
  • Network or Host Issues: Verify the host URL is reachable and correct.
  • Header Conflicts: Custom headers can override defaults; ensure no conflicting headers like Content-Type unless intended.

If the node throws errors, enabling "Continue On Fail" allows processing subsequent items without stopping the workflow.

Links and References

Discussion