Create Blueprint

POST https://api.app.shipyardapp.com/orgs/{org_id}/blueprints

Create a new Blueprint in the target Organization

Request Body

The payload is a JSON definition of a Blueprint. Several things to note about the payload are below.

1. state value options are 1 (Disabled), 2 (Draft), and 3 (Enabled).
2. pallet_type value options are 2 (Python), 3 (Bash), and 7 (Node).
3. program value options are python3, bash, and node and should correspond with pallet_type.
4. type for a spec_list object value options are 1 (String), 2 (Integer), 3 (Floating), 4 (Boolean), 5 (Date), 6 (Select), 7 (Password), 8 (External file). For select input types, the type_spec field will be an array of objects containing name and value fields and a default selection must be made corresponding to one of the object name fields.
5. number_of_retries can be between 0 and 24.
6. ttr can be between 0 and 3600 in increments of 300.
7. runtime_timeout can be between 300 and 3600.
8. exclude_exit_code_ranges may contain an array of arrays each with two integers between 1 and 255 - in the example below, the exit codes 1, 3, 4, and 5 are ignored.
9. external_file holds a temp field with an object with id and url keys - these are populated using the RequestID and ExternalFile values from the Create External File response.

Here's an example Blueprint JSON payload.

JSON

{
    "name": "Test Blueprint",
    "synopsis": "Example synopsis",
    "description": "Example description",
    "state": 3,
    "pallet_type": 2,
    "pallet_config": {
        "version": "3.7",
        "command": {
            "program": "python3",
            "file_to_run": "script.py"
        },
        "external_file": {
            "temp": {
                "file_name": "script.py",
                "id": "TEMP",
                "url": "s3://production-shipyard-uploads-tmp/tmp/organizations/TEMP/requests/TEMP.sefv2_TEMP"
            }
        }
    },
    "spec_list": [
        {
            "display_name": "First Input",
            "name": "FIRST_INPUT",
            "type": 1,
            "required": false,
            "placeholder": "Enter a first input",
            "description": "A first input",
            "default": "example_value",
            "type_spec": {
                "multiline": false
            }
        }
    ],
    "retry_strategy": {
        "number_of_retries": 3,
        "ttr": 900
    },
    "runtime_timeout": 2700,
    "exclude_exit_code_ranges": [
        [
            1,
            1
        ],
        [
            3,
            5
        ]
    ]
}