Blueprints

List Blueprints

get

Retrieves a paginated list of blueprints.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Query parameters

filter[name]stringOptional

Filter results by name.

filter[labelled]stringOptional

Filter results by label id.

filter[,]stringOptional

Filter results by ,.

filter[intval]stringOptional

Filter results by intval.

filter[labelTemplates]stringOptional

Filter results by labelTemplates.

filter[label_templates.id]stringOptional

Filter results by label_templates.id.

sortstringOptional

Sort field. Prefix with - for descending. Available: created_at, updated_at, name

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get/api/v1/patchworks/blueprints

GET /api/v1/patchworks/blueprints HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Create Blueprint

post

Creates a new blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/patchworks/blueprints

POST /api/v1/patchworks/blueprints HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Blueprint

get

Retrieves the details of a specific blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[labelled]stringOptional

Filter results by label id.

filter[,]stringOptional

Filter results by ,.

filter[intval]stringOptional

Filter results by intval.

filter[labelTemplates]stringOptional

Filter results by labelTemplates.

filter[label_templates.id]stringOptional

Filter results by label_templates.id.

sortstringOptional

Sort field. Prefix with - for descending. Available: created_at, updated_at, name

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get/api/v1/patchworks/blueprints/{blueprint}

GET /api/v1/patchworks/blueprints/{blueprint} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Update Blueprint

put

Updates an existing blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put/api/v1/patchworks/blueprints/{blueprint}

PUT /api/v1/patchworks/blueprints/{blueprint} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Delete Blueprint

delete

Permanently deletes a specific blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

delete/api/v1/patchworks/blueprints/{blueprint}

DELETE /api/v1/patchworks/blueprints/{blueprint} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Unpublished

get

Retrieves blueprints that have not yet been published.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get/api/v1/patchworks/blueprints/unpublished

GET /api/v1/patchworks/blueprints/unpublished HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Post Install Options

get

Retrieves the available post-install action options for blueprints.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get/api/v1/patchworks/blueprints/post-install-options

GET /api/v1/patchworks/blueprints/post-install-options HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Install Blueprint

post

Installs the active version of a specific blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Body

flow_template_idsstringOptional

instancesstringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/blueprints/{blueprint}/install

POST /api/v1/blueprints/{blueprint}/install HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "flow_template_ids": "example_flow_template_ids",
  "instances": "example_instances",
  "post_install": "example_post_install"
}

{}

Install Blueprint Version

post

Installs a specific version of a specific blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

versionstringRequired

The version identifier.

Body

flow_template_idsstringOptional

instancesstringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/blueprints/{blueprint}/versions/{version}/install

POST /api/v1/blueprints/{blueprint}/versions/{version}/install HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "flow_template_ids": "example_flow_template_ids",
  "instances": "example_instances",
  "post_install": "example_post_install"
}

{}

Install Blueprint

get

To be confirmed.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get/api/v1/patchworks/blueprints/{blueprint}/install

GET /api/v1/patchworks/blueprints/{blueprint}/install HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

List Blueprint Installs

get

Retrieves a paginated list of installs for a specific blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Query parameters

filter[version]stringOptional

Filter results by version.

filter[search]stringOptional

Filter results by search.

includestringOptional

Comma-separated list of relationships to include. Available: company, marketplaceApp

sortstringOptional

Sort field. Prefix with - for descending. Available: id, version, created_at

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get/api/v1/patchworks/blueprints/{blueprint}/installs

GET /api/v1/patchworks/blueprints/{blueprint}/installs HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

List Blueprint Bulk Installs

get

Retrieves a paginated list of bulk install batches for a specific blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get/api/v1/patchworks/blueprints/{blueprint}/installs/bulk

GET /api/v1/patchworks/blueprints/{blueprint}/installs/bulk HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Create Blueprint Bulk Install

post

Creates a new bulk install batch for a specific blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/patchworks/blueprints/{blueprint}/installs/bulk

POST /api/v1/patchworks/blueprints/{blueprint}/installs/bulk HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Blueprint Bulk Install Batch

get

Retrieves the details of a specific bulk install batch.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

batchstringRequired

The batch identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get/api/v1/patchworks/blueprints/{blueprint}/installs/bulk/{batch}

GET /api/v1/patchworks/blueprints/{blueprint}/installs/bulk/{batch} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Cancel Blueprint Install Bulk

post

Cancels a specific in-progress bulk install batch.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

batchstringRequired

The batch identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/patchworks/blueprints/{blueprint}/installs/bulk/{batch}/cancel

POST /api/v1/patchworks/blueprints/{blueprint}/installs/bulk/{batch}/cancel HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

List Blueprint Bulk Install Batch Items

get

Retrieves a paginated list of items for a specific bulk install batch.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

batchstringRequired

The batch identifier.

Query parameters

filter[status]stringOptional

Filter results by status.

filter[company_id]stringOptional

Filter results by company_id.

filter[company]stringOptional

Filter results by company.

includestringOptional

Comma-separated list of relationships to include. Available: company

sortstringOptional

Sort field. Prefix with - for descending. Available: id, status, created_at

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get/api/v1/patchworks/blueprints/{blueprint}/installs/bulk/{batch}/items

GET /api/v1/patchworks/blueprints/{blueprint}/installs/bulk/{batch}/items HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Blueprint Bulk Install Batch Item

get

Retrieves the details of a specific bulk install batch item.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

batchstringRequired

The batch identifier.

itemstringRequired

The item identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get/api/v1/patchworks/blueprints/{blueprint}/installs/bulk/{batch}/items/{item}

GET /api/v1/patchworks/blueprints/{blueprint}/installs/bulk/{batch}/items/{item} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

List Blueprint Versions

get

Retrieves a paginated list of versions for a specific blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get/api/v1/patchworks/blueprints/{blueprint}/versions

GET /api/v1/patchworks/blueprints/{blueprint}/versions HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Active Blueprint Version

get

Retrieves the currently active version of a specific blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get/api/v1/patchworks/blueprints/{blueprint}/versions/active

GET /api/v1/patchworks/blueprints/{blueprint}/versions/active HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Blueprint Version

get

Retrieves the details of a specific blueprint version.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

versionstringRequired

The version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get/api/v1/patchworks/blueprints/{blueprint}/versions/{version}

GET /api/v1/patchworks/blueprints/{blueprint}/versions/{version} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Delete Blueprint Version

delete

Permanently deletes a specific blueprint version.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

versionstringRequired

The version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

delete/api/v1/patchworks/blueprints/{blueprint}/versions/{version}

DELETE /api/v1/patchworks/blueprints/{blueprint}/versions/{version} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Activate Blueprint Version

post

Sets a specific blueprint version as the active version.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

versionstringRequired

The version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/patchworks/blueprints/{blueprint}/versions/{version}/activate

POST /api/v1/patchworks/blueprints/{blueprint}/versions/{version}/activate HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Blueprint Draft

get

Retrieves the draft manifest for a specific blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get/api/v1/blueprints/{blueprint}/draft

GET /api/v1/blueprints/{blueprint}/draft HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Create Blueprint Draft

post

Creates a new draft manifest for a specific blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/blueprints/{blueprint}/draft

POST /api/v1/blueprints/{blueprint}/draft HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Delete Blueprint Draft

delete

Permanently deletes the draft manifest for a specific blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete/api/v1/blueprints/{blueprint}/draft

DELETE /api/v1/blueprints/{blueprint}/draft HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Action completed successfully."
}

Update Blueprint Draft

patch

Updates the draft manifest for a specific blueprint.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

patch/api/v1/blueprints/{blueprint}/draft

PATCH /api/v1/blueprints/{blueprint}/draft HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Check Blueprint Draft

get

To be confirmed.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get/api/v1/blueprints/{blueprint}/draft/check

GET /api/v1/blueprints/{blueprint}/draft/check HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}

Publish Blueprint Draft

post

Publishes the draft manifest for a specific blueprint, creating a new version.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/blueprints/{blueprint}/draft/publish

POST /api/v1/blueprints/{blueprint}/draft/publish HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}

Reset Blueprint Draft

post

Resets the draft manifest for a specific blueprint to match the current active version.

Authorizations

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

blueprintstringRequired

The blueprint identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/blueprints/{blueprint}/draft/reset

POST /api/v1/blueprints/{blueprint}/draft/reset HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}