Akamai API icon

Akamai API

Interact with Akamai APIs

Actions5

PATCH Request

AI-generated

Overview

This node allows users to interact with Akamai APIs by making HTTP requests authenticated via Akamai EdgeGrid. Specifically, the PATCH Request operation enables updating resources on Akamai's platform by sending partial modifications to an existing resource. This is useful for scenarios such as updating user profiles, modifying configuration settings, or patching data without replacing the entire resource.

Practical examples include:

  • Updating a user's profile information in an identity management system.
  • Modifying specific fields of a content delivery configuration.
  • Adjusting access control rules partially without full replacement.

Properties

Name Meaning
API Path The endpoint path of the Akamai API to which the PATCH request will be sent. Must start with a slash (e.g., /identity-management/v3/user-profile).
Request Body JSON object representing the body of the PATCH request. Contains the fields and values to update on the target resource.
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 Boolean flag indicating if the node should return the full response including metadata ({ meta, data }) instead of only the response body.
Options Collection of additional options:
- Query Parameters: Key-value pairs 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 with the response from the Akamai API:

  • If Return Full Response is false (default), the output json contains the parsed response body from the PATCH request.
  • 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 data.

The node does not output binary data.

Dependencies

  • Requires an Akamai EdgeGrid API credential with valid 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 be configured in the credentials.
  • No additional environment variables are required beyond the API credential.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect API path or method may result in 404 or 405 HTTP errors.
    • Malformed JSON in the Request Body can cause parsing errors.
    • Network connectivity issues to Akamai endpoints.

  • Error messages:

    • Errors returned from the Akamai API are parsed and included in the output under an error property.
    • Parsing errors of the response body are caught and reported with raw response included.
    • If the node is set to continue on fail, errors for individual items are returned as JSON objects with an error message.

  • Resolutions:

    • Verify API credentials and permissions.
    • Ensure the API path is correct and starts with a slash.
    • Validate JSON syntax in the Request Body.
    • Check network connectivity and firewall settings.

Links and References

Discussion