http
Sends one HTTP request to another system, with secrets by name and an optional signature, and keeps the answer for references.
A step of a YAML migration with type: http. The class expMigrationStepHttp (kernel/classes/migration/steps/expmigrationstephttp.php) is registered in settings/migration.ini [StepSettings] StepTypeList[http].
Keys
| Key | Type | Default | What it is |
|---|---|---|---|
method | string: GET, POST, PUT, PATCH, DELETE, HEAD | "GET" | the method |
url | string | required | http:// or https:// with a host, without a user or password |
headers | map | header => value (no secrets here: secret_headers:) | |
secret_headers | map | header => the name of a secret (Setup > Secrets, or env:<VARIABLE>) | |
bearer | string | the name of a secret sent as Authorization: Bearer <value> | |
body | string | the body as a text | |
json | any | the body as JSON (Content-Type: application/json) | |
sign | string | the name of a secret that signs the request as webhooks of Exponential are signed | |
expect | list | the status codes that pass (default: any 2xx) | |
timeout | int | 30 | seconds |
Besides these, every step takes the keys of the engine: type, mode, if, references, environments, engines and comment (the file format). A key of type identifier names a node, an object or another part of the installation by id, remote id, path or name (identifiers).
Values for references
references: { <name>: <value> } keeps a value of the step's result as ${ref.<name>} for the steps and migrations after it:
| Value | What it is |
|---|---|
status | the status code of the answer |
body | the body of the answer (at most 64 KB) |
json | the body decoded as JSON (null when it is not) |
Undoing
A step of this type does not undo itself: a migration with it needs down: or a rollback to its caption.
It touches no cache.
Example
- type: http
method: POST
url: https://cdn.example.com/purge
bearer: cdn.token
json: { paths: [ "/news/*" ] }
expect: [ 200, 202 ]
references: { purge_status: status }Related
Generated by ./console exp:help:examples from settings/migration.ini, kernel/classes/migration/steps/expmigrationstephttp.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.