Scenarios > Blueprints

The following endpoints allow you to manage scenarios blueprints.

Get scenario blueprint

get
/scenarios/{scenarioId}/blueprint

Retrieves a blueprint of a scenario with a given ID.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
scenarioIdintegerRequired

The ID of the scenario. You can get the scenarioId with the List scenarios API call.

Example: 112
Query parameters
blueprintIdintegerOptional

The unique ID of the blueprint version. It can be retrieved from the Get blueprint versions endpoint. This parameter can be useful when you want to retrieve the older version of the blueprint.

Example: 12
draftbooleanOptional

If this parameter is set to true, the draft version of the scenario blueprint will be retrieved. If set to false, the live version of the blueprint will be retrieved. In case that the blueprintId parameter is set to the query as well, this parameter is ignored.

Example: false
Responses
200

Blueprint retrieved

application/json
get
/scenarios/{scenarioId}/blueprint
GET /api/v2/scenarios/{scenarioId}/blueprint HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Blueprint retrieved

{
  "code": "OK",
  "response": {
    "blueprint": {
      "name": "Empty integration",
      "flow": [
        {
          "id": 2,
          "module": "json:ParseJSON",
          "version": 1,
          "metadata": {
            "designer": {
              "x": -46,
              "y": 47,
              "messages": [
                {
                  "category": "last",
                  "severity": "warning",
                  "message": "A transformer should not be the last module in the route."
                }
              ]
            }
          }
        }
      ],
      "metadata": {
        "version": 1,
        "scenario": {
          "roundtrips": 1,
          "maxErrors": 3,
          "autoCommit": true,
          "autoCommitTriggerLast": true,
          "sequential": false,
          "confidential": false,
          "dataloss": false,
          "dlq": false,
          "freshVariables": false
        },
        "designer": {
          "orphans": []
        }
      }
    },
    "scheduling": {
      "type": "indefinitely",
      "interval": 900
    },
    "idSequence": 4,
    "created": "2021-09-22T09:28:41.129Z",
    "last_edit": "2021-09-22T09:40:31.488Z"
  }
}

Get blueprint versions

get
/scenarios/{scenarioId}/blueprints

Retrieves a collection of all blueprints versions for a scenario with a given ID. Due to the regular archiving process, only the versions that are not older than 60 days can be retrieved. Each returned blueprint version consists of the date and time of the blueprint creation, IDs of the blueprint version and related scenario, and the information if the blueprint was created for the draft or live scenario version.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
scenarioIdintegerRequired

The ID of the scenario. You can get the scenarioId with the List scenarios API call.

Example: 112
Responses
200

Blueprints versions successfully retrieved

application/json
get
/scenarios/{scenarioId}/blueprints
GET /api/v2/scenarios/{scenarioId}/blueprints HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Blueprints versions successfully retrieved

{
  "scenariosBlueprints": {
    "created": "2021-08-25T17:48:07.360Z",
    "version": 16,
    "scenarioId": 424,
    "draft": false
  }
}

Last updated