Platform API - Trigger Fleet
Overviewβ
Quickly trigger an existing fleet in Platform to run without waiting for completion
Variablesβ
Name | Reference | Type | Required | Default | Options | Description |
---|---|---|---|---|---|---|
Shipyard API Key | SHIPYARD_API_KEY | Password | β | - | - | The API key that Platform generated for you |
Project ID | SHIPYARD_API_PROJECT_ID | Alphanumeric | β | - | - | The project ID where the target fleet resides |
Fleet ID | SHIPYARD_API_FLEET_ID | Alphanumeric | β | - | - | The ID of the fleet to trigger |
YAMLβ
Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.
source:
blueprint: Shipyard API - Trigger Fleet
inputs:
SHIPYARD_API_KEY: null ## REQUIRED
SHIPYARD_API_PROJECT_ID: null ## REQUIRED
SHIPYARD_API_FLEET_ID: null ## REQUIRED
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '101'
- '102'
- '103'
- '104'
- '105'
- '106'
- '249'