Script Versions

Show

get

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

• content

• content_count

• contentExists

• script

• script_count

• scriptExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

• is_deployed

Authorizations

ApiKeyAuth

Path parameters

script_versionstringRequired

The script version identifier.

Query parameters

filter[is_deployed]stringOptional

Filter results by is_deployed.

filter[deployed_at]stringOptional

Filter results by deployed_at.

includestringOptional

Comma-separated list of relationships to include. Available: content, script

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/script-versions/{script_version}

HTTPcURLJavaScriptPython

GET /api/v1/script-versions/{script_version} 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",
    "script_id": 1,
    "name": "My Example",
    "version": 1,
    "status": "Draft",
    "deployment_failure_reason": "example_deployment_failure_reason",
    "last_invoked_on": "example_last_invoked_on",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployment_failed_at": "2025-01-15T10:30:00.000000Z",
    "deploying": "example_deploying",
    "content": {},
    "script": {}
  }
}

Destroy

delete

Delete a script version.

Authorizations

ApiKeyAuth

Path parameters

script_versionstringRequired

The script version identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

delete

/api/v1/script-versions/{script_version}

HTTPcURLJavaScriptPython

DELETE /api/v1/script-versions/{script_version} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

Deploy

post

Deploy for deploy.

Authorizations

ApiKeyAuth

Path parameters

script_versionstringRequired

The script version identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/script-versions/{script_version}/deploy

HTTPcURLJavaScriptPython

POST /api/v1/script-versions/{script_version}/deploy HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

Invoke

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
variables
payload	string
flow
flow.variables

Authorizations

ApiKeyAuth

Path parameters

script_versionstringRequired

The script version identifier.

Body

application/json

variablesstringOptional

payloadstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/script-versions/{script_version}/invoke

HTTPcURLJavaScriptPython

POST /api/v1/script-versions/{script_version}/invoke HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "variables": "example_variables",
  "payload": "example_payload",
  "flow": "example_flow"
}

{}

Index

get

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
since
tail

Authorizations

ApiKeyAuth

Path parameters

script_versionstringRequired

The script version identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/script-versions/{script_version}/logs

HTTPcURLJavaScriptPython

GET /api/v1/script-versions/{script_version}/logs 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",
      "script_id": 1,
      "name": "My Example",
      "version": 1,
      "status": "Draft",
      "deployment_failure_reason": "example_deployment_failure_reason",
      "last_invoked_on": "example_last_invoked_on",
      "deployed_at": "2025-01-15T10:30:00.000000Z",
      "deployment_failed_at": "2025-01-15T10:30:00.000000Z",
      "deploying": "example_deploying",
      "content": {},
      "script": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/script-versions/{script_version}/logs",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/script-versions/{script_version}/logs?page=1",
    "last": "https://api.example.com/api/v1/script-versions/{script_version}/logs?page=1",
    "prev": null,
    "next": null
  }
}

Script-Upload

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
private

Authorizations

ApiKeyAuth

Path parameters

script_versionstringRequired

The script version identifier.

Body

application/json

privatestringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/script-versions/{script_version}/upload

HTTPcURLJavaScriptPython

POST /api/v1/script-versions/{script_version}/upload HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "private": "example_private"
}

{}