Invoke HTTP call action

post

/api/pvlt/1.0/data/actions/http_call

Invokes the built-in http_call action.

The http_call action enables Vault to issue an HTTP call using a template that includes references to sensitive data.

Read more about using the http_call action.

The role performing this operation must have:

• The CapActionInvoker capability.
• At least one allowing policy and no denying policies for the invoke operation for the action provided in the call.

See identity and access management for more information about how capabilities are used to control access to operations and policies are used to control access to data.

Request

Query parameters

• adhoc_reason - string

  An ad-hoc reason for accessing the Vault data. Required when reason is set to Other.

• reason - string required*

  Details of the reason for requesting the property. The default is set when no access reason is provided and PVAULT_SERVICE_FORCE_ACCESS_REASON is false.

  Allowed values: AppFunctionality, Analytics, Notifications, Marketing, ThirdPartyMarketing, FraudPreventionSecurityAndCompliance, AccountManagement, Maintenance, DataSubjectRequest, Other
• reload_cache - boolean

  Reloads the cache before the action.

Request body

The request specification. See http_call request body for more details.

application/json

object required*

Additional properties: falseProperties:

• template_variables - object required*

  A key-value map of template variable names to Vault global identifiers.

  Values of additional properties are strings

  Example

  {
    "to_email": "pvlt:detokenize:customers:email:463a83d0-a816-4902-abba-2486e0c0a0bb:",
    "first_name": "pvlt:read_object:customers:first_name:463a83d0-a816-4902-abba-2486e0c0a0bb:"
  }
• request - object required*

  The HTTP request template.

  Additional properties: falseProperties:

  • url - string required*

    The URL to call.

    Example: "https://example-email-server.com/send-email"
  • method - string

    The HTTP method to use.

    Default: GETAllowed values: GET, HEAD, POST, PUT, PATCH, DELETE, CONNECT, OPTIONS, TRACEExample: "POST"
  • headers - object

    The HTTP headers to send.

    Values of additional properties are strings

    Example

    {
      "Content-Type": "application/json"
    }
  • body - string

    The HTTP body to send.

    Example: "{\"to\": \"{{ .to_email }}\", \"message\": \"Hello {{ .first_name }}!\" }"
• include_response_body - boolean

  Whether to include the response body in the action result. Set as false, or use the default, to ensure any sensitive data in the response body isn't returned in the action result.

  Default: false

Example

{
  "template_variables": {
    "to_email": "pvlt:detokenize:customers:email:463a83d0-a816-4902-abba-2486e0c0a0bb:",
    "first_name": "pvlt:read_object:customers:first_name:463a83d0-a816-4902-abba-2486e0c0a0bb:"
  },
  "request": {
    "url": "https://example-email-server.com/send-email",
    "method": "POST",
    "headers": {
      "Content-Type": "application/json"
    },
    "body": "{\"to\": \"{{ .to_email }}\", \"message\": \"Hello {{ .first_name }}!\" }"
  },
  "include_response_body": false
}

Possible responses

200

The request is successful.

application/json

object required*

Additional properties: falseProperties:

• status_code - integer required*

  The HTTP status code of the response.

  Example: 200
• headers - object required*

  The HTTP headers of the response.

  Values of additional properties are strings

  Example

  {
    "Content-Type": "application/json"
  }
• body - string

  The HTTP body of the response.

  Example: "{\"status\": \"success\"}"

Example

{
  "status_code": 200,
  "headers": {
    "Content-Type": "application/json"
  },
  "body": "{\"status\": \"success\"}"
}

400

The request is invalid.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1001",
  "message": "The access reason is missing.",
  "context": {
    "reason": null
  }
}

401

Authentication credentials are incorrect or missing.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1005",
  "message": "The request is unauthorized.",
  "context": {}
}

403

The caller doesn't have the required access rights.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1007",
  "message": "The operation is forbidden due to missing capabilities.",
  "context": {
    "username": "WebServer"
  }
}

404

The requested resource is not found.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1004",
  "message": "The collection is not found.",
  "context": {}
}

405

The operation is not allowed.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1026",
  "message": "The operation is not allowed in in-memory mode.",
  "context": {}
}

409

A conflict occurs.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV3218",
  "message": "Concurrent conflicting updates to the same object.",
  "context": {}
}

410

Access to a resource that is no longer available occurs.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1033",
  "message": "The resource is gone.",
  "context": {}
}

500

An error occurs on the server.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1000",
  "message": "Something went wrong",
  "context": {}
}

503

The service is unavailable.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1009",
  "message": "The operation timed out on the server.",
  "context": {}
}

Try the API

Authorization

API key:

Query parameters

Adhoc_reason:

Reason*:

Reload_cache:

Request body

Content-Type:

Navigate to the docs of your local Vault installation to try the API directly from there.

Code examples

Example