Script Versions

Get Script Version

get

Retrieves the details of a specific script version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

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

{
  "data": {
    "id": "string",
    "script_id": "string",
    "name": "string",
    "version": 0,
    "status": "string",
    "deployment_failure_reason": null,
    "last_invoked_on": null,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployment_failed_at": null,
    "deploying": false
  }
}

Delete Script Version

delete

Permanently deletes a specific script version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

script_versionstringRequired

The script version identifier.

Responses

200

Successful response

application/json

messagestringOptional

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

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

Upload Script Version

post

Uploads a given script version to your private marketplace.

This operation requires administrator permissions. If you are authorising requests with an API key, this request won't work (company-level API keys are associated with manager-level permissions). If you are an administrator, you can use OAuth 2 credentials to complete this operation. For more information please see our Authentication section.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

script_versionstringRequired

The script version identifier.

Body

application/json

privatestringOptional

Responses

200

Successful response

application/json

objectOptional

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

{
  "private": "text"
}

{
  "message": "string"
}

Deploy Script Version

post

Deploys a specific script version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

script_versionstringRequired

The script version identifier.

Responses

200

Successful response

application/json

objectOptional

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

{}

Invoke Script Version

post

Invokes a specific script version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

script_versionstringRequired

The script version identifier.

Body

application/json

variablesstringOptional

payloadstringOptional

Responses

200

Successful response

application/json

objectOptional

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

{
  "variables": "text",
  "payload": "text",
  "flow": {
    "variables": "text"
  }
}

{}

List Script Version Logs

get

Retrieves a list of logs for a specific script version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

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

{
  "data": [
    {
      "timestamp": "2025-01-15T10:30:00+00:00",
      "text": "string"
    }
  ]
}

List Script Versions

get

Retrieves a paginated list of versions for a specific script. Can be filtered by is_deployed and deployed_at.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

scriptstringRequired

The script 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/scripts/{script}/script-versions

HTTPcURLJavaScriptPython

GET /api/v1/scripts/{script}/script-versions HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "string",
      "script_id": "string",
      "name": "string",
      "version": 0,
      "status": "string",
      "deployment_failure_reason": null,
      "last_invoked_on": null,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "deployed_at": "2025-01-15T10:30:00.000000Z",
      "deployment_failed_at": null,
      "deploying": false
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 15,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "string",
    "last": "string",
    "prev": null,
    "next": null
  }
}

Create Script Version

post

Creates a new version for a specific script.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

scriptstringRequired

The script identifier.

Body

application/json

contentstring · min: 1Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

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

HTTPcURLJavaScriptPython

POST /api/v1/scripts/{script}/script-versions HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "content": "text"
}

{
  "data": {
    "id": "string",
    "script_id": "string",
    "name": "string",
    "version": 0,
    "status": "string",
    "deployment_failure_reason": null,
    "last_invoked_on": null,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployment_failed_at": null,
    "deploying": false
  }
}