Akamai API icon

Akamai API

Interact with Akamai APIs

Actions5

PUT Request

AI-generated

Overview

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

Common scenarios include updating user profiles, configurations, or other resources managed through Akamai's APIs. For example, you might update identity management settings or modify CDN configurations by specifying the appropriate API path and request body.

Properties

Name Meaning
API Path The endpoint path of the Akamai API to which the PUT request will be sent (e.g., /identity-management/v3/user-profile).
Request Body JSON object representing the data to send in the PUT request body. Used for POST/PUT/PATCH operations.
PAPI Use Prefixes Controls whether to override the client's default setting for ID prefixes in responses (like prp_, ctr_, grp_). Options: Don't Send Header, Include Prefixes (True), Remove Prefixes (False). Leave empty to use client default.
Return Full Response Boolean flag indicating if the node should return the full response including metadata ({ meta, data }) instead of just the response body. Defaults to false.
Options Collection of additional options:
- Query Parameters (qs) Key-value pairs to add as query parameters to the request URL.
- Headers Custom headers to include in the request.

Output

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

  • If Return Full Response is set to 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 headers.
    • data: The actual response body from the API.

The node does not output binary data.

Dependencies

  • Requires valid Akamai EdgeGrid credentials (client token, client secret, access token, and host).
  • Uses the akamai-edgegrid npm package to handle authentication and request signing.
  • The node expects the Akamai API host URL to start with http or it prepends https:// automatically.

Troubleshooting

  • Invalid Credentials or Authentication Errors: Ensure that the Akamai EdgeGrid credentials are correctly configured and have sufficient permissions for the requested API path.
  • Malformed JSON in Request Body: The Request Body must be valid JSON. Invalid JSON strings will cause parsing errors.
  • Missing or Incorrect API Path: The API Path must start with a slash (/). The node automatically adds it if missing, but ensure the path is correct.
  • Unexpected Response Parsing Errors: If the API returns non-JSON or malformed JSON, the node attempts to parse it and may throw errors. Check the raw response for troubleshooting.
  • Network or Connectivity Issues: Verify network connectivity to the Akamai API host and that no firewall or proxy blocks the requests.
  • Error Responses from API: When the API returns an error, the node includes the status code and error message in the output. Enable "Return Full Response" to get detailed metadata for debugging.

Links and References

Discussion