Blueprints | API Reference (WIP) | Product documentation

Show

get

Get a single draft.

Authorizations

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
Accept: */*

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

Store

post

Create a new draft.

Authorizations

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
Accept: */*

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

Destroy

delete

Delete a draft.

Authorizations

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
Accept: */*

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

Update

patch

Update an existing draft.

Authorizations

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
Accept: */*

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

Check

get

Check for check.

Authorizations

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
Accept: */*

{}

Publish

post

Publish for publish.

Authorizations

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
Accept: */*

{}

Reset

post

Reset for reset.

Authorizations

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
Accept: */*

{}

Install-Active

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

flow_template_ids

flow_template_ids.*

integer

dry_run

instances

instances.*.system_template_id

integer

☑

instances.*.connector_id

integer

instances.*.canonical_key

string

instances.*.name

string

instances.*.timezone

string

instances.*.date_format

string

instances.*.rate_limit_unit

string

instances.*.rate_limit_duration

integer

instances.*.connection_pool_id

integer

instances.*.authentication_implementation_template_id

integer

instances.*

post_install

post_install.action

Authorizations

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
Content-Type: application/json
Accept: */*
Content-Length: 119

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

{}

Install

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field

Type

Required

flow_template_ids

flow_template_ids.*

integer

dry_run

instances

instances.*.system_template_id

integer

☑

instances.*.connector_id

integer

instances.*.canonical_key

string

instances.*.name

string

instances.*.timezone

string

instances.*.date_format

string

instances.*.rate_limit_unit

string

instances.*.rate_limit_duration

integer

instances.*.connection_pool_id

integer

instances.*.authentication_implementation_template_id

integer

instances.*

post_install

post_install.action

Authorizations

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
Content-Type: application/json
Accept: */*
Content-Length: 119

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

{}

Index

get

List all blueprints.

Authorizations

Query parameters

filter[name]stringOptional

Filter results by name.

filter[labelled]stringOptional

Filter results by labelled.

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
Accept: */*

No content

Store

post

Create a new blueprint.

Authorizations

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
Accept: */*

No content

Get Post Install Options

get

Get Post Install Options for post install options.

Authorizations

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
Accept: */*

No content

Get Unpublished

get

Get Unpublished for unpublished.

Authorizations

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
Accept: */*

No content

Show

get

Get a single blueprint.

Authorizations

Path parameters

blueprintstringRequired

The blueprint identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[labelled]stringOptional

Filter results by labelled.

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
Accept: */*

No content

Update

put

Update an existing blueprint.

Authorizations

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
Accept: */*

No content

Destroy

delete

Delete a blueprint.

Authorizations

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
Accept: */*

No content

Install

get

Install for install.

Authorizations

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
Accept: */*

No content

Index

get

List all installs.

Authorizations

Path parameters

blueprintstringRequired

The blueprint identifier.

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
Accept: */*

No content

Index

get

List all bulk.

Authorizations

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
Accept: */*

No content

Store

post

Create a new bulk.

Authorizations

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
Accept: */*

No content

Show

get

Get a single bulk.

Authorizations

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
Accept: */*

No content

Cancel

post

Cancel for cancel.

Authorizations

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
Accept: */*

No content

Index

get

List all items.

Authorizations

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}/items

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

No content

Show

get

Get a single item.

Authorizations

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
Accept: */*

No content

Index

get

List all versions.

Authorizations

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
Accept: */*

No content

Index

get

List all active.

Authorizations

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
Accept: */*

No content

Show

get

Get a single version.

Authorizations

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
Accept: */*

No content

Destroy

delete

Delete a version.

Authorizations

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
Accept: */*

No content

Activate

post

Activate for activate.

Authorizations

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
Accept: */*

No content

hashtagShow

hashtagStore

hashtagDestroy

hashtagUpdate

hashtagCheck

hashtagPublish

hashtagReset

hashtagInstall-Active

hashtagValidation Rules

hashtagInstall

hashtagValidation Rules

hashtagIndex

hashtagStore

hashtagGet Post Install Options

hashtagGet Unpublished

hashtagShow

hashtagUpdate

hashtagDestroy

hashtagInstall

hashtagIndex

hashtagIndex

hashtagStore

hashtagShow

hashtagCancel

hashtagIndex

hashtagShow

hashtagIndex

hashtagIndex

hashtagShow

hashtagDestroy

hashtagActivate

Show

Store

Destroy

Update

Check

Publish

Reset

Install-Active

Validation Rules

Install

Validation Rules

Index

Store

Get Post Install Options

Get Unpublished

Show

Update

Destroy

Install

Index

Index

Store

Show

Cancel

Index

Show

Index

Index

Show

Destroy

Activate