Metaplane Run

Metaplane Run

Certified

Run one or more Metaplane monitors now

Enqueues the given monitors to run immediately through the Metaplane API. The API responds as soon as the run is enqueued (HTTP 200), not once it has completed, and does not return a run identifier. Use the Get task or the MonitorResultTrigger afterwards to read the resulting status once the monitor has finished running.

yaml
type: io.kestra.plugin.metaplane.Run

Run a Metaplane monitor, wait for it to complete, then gate the pipeline on its result

yaml
id: metaplane_gate
namespace: company.team

tasks:
  - id: run_monitor
    type: io.kestra.plugin.metaplane.Run
    apiToken: "{{ secret('METAPLANE_API_TOKEN') }}"
    monitorIds:
      - "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  - id: wait_for_monitor_run
    type: io.kestra.plugin.core.flow.Pause
    # Run only enqueues the monitor and does not wait for completion; this pause gives it
    # time to finish before Get reads its status. For a guaranteed-fresh result instead of
    # a fixed wait, react to io.kestra.plugin.metaplane.MonitorResultTrigger in a separate flow.
    pauseDuration: PT1M
  - id: get_result
    type: io.kestra.plugin.metaplane.Get
    apiToken: "{{ secret('METAPLANE_API_TOKEN') }}"
    monitorId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  - id: halt_on_anomaly
    type: io.kestra.plugin.core.execution.Fail
    condition: "{{ outputs.get_result.status == 'FAIL' }}"
Properties

Metaplane API token

API token used to authenticate against the Metaplane API. Generate one at https://app.metaplane.dev/account/manage-tokens and store it as a Kestra secret.

SubTypestring

Monitor IDs to run

UUIDs of the Metaplane monitors to enqueue for an immediate run. Must contain at least one ID.

Defaulthttps://dev.api.metaplane.dev

Metaplane API base URL

Base endpoint for all Metaplane API calls. Defaults to https://dev.api.metaplane.dev.

HTTP client options

Optional HTTP configuration (timeouts, proxy, SSL) applied to every Metaplane API call.

Definitions
allowFailedbooleanstring
Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray
SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

type*Requiredobject
passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

type*Requiredobject
tokenstring

The token for bearer token authentication.

type*Requiredobject
passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordDeprecatedstring

The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

basicAuthUserDeprecatedstring

The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

connectTimeoutDeprecatedstring
Formatduration

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeoutDeprecatedstring
Formatduration

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharsetstring
DefaultUTF-8

The default charset for the request.

enabledTcpExtendedKeepAlivebooleanstring
Defaulttrue

Whether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).

Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.

followRedirectsbooleanstring
Defaulttrue

Whether redirects should be followed automatically.

logLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthDeprecatedinteger

The maximum content length of the response.

proxy

The proxy configuration.

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring
DefaultDIRECT
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

proxyAddressDeprecatedstring

The address of the proxy server.

proxyPasswordDeprecatedstring

The password for proxy authentication.

proxyPortDeprecatedinteger

The port of the proxy server.

proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernameDeprecatedstring

The username for proxy authentication.

readIdleTimeoutDeprecatedstring
Formatduration

The time allowed for a read connection to remain idle before closing it.

readTimeoutDeprecatedstring
Formatduration

The maximum time allowed for reading data from the server before failing.

ssl

The SSL request options

insecureTrustAllCertificatesbooleanstring

Whether to disable checking of the remote SSL certificate.

Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.

timeout

The timeout configuration.

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring
DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

Reference (ref) of the pluginDefaults to apply to this task.

SubTypestring

Monitor IDs that were enqueued to run

More Plugins in this Category

Liquibase
Liquibase

Tasks that run Liquibase change management commands.

Data

2 tasks

PostgreSQL
PostgreSQL

Tasks that connect to PostgreSQL via JDBC to run queries and loads.

Data

6 tasks

25 blueprints