Scripts

List Scripts

get

Retrieves a paginated list of scripts. Can be filtered by name and versions.id.

Authorizations

AuthorizationstringRequired

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

Query parameters

filter[name]stringOptional

Filter results by name.

filter[versions.id]stringOptional

Filter results by versions.id.

includestringOptional

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

sortstringOptional

Sort field. Prefix with - for descending. Available: name

fields[versions]stringOptional

Comma-separated list of versions fields to return. Available: id, script_id, version, name, deployed_at, deployment_failed_at, deploying, deployment_failure_reason

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

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

{
  "data": [
    {
      "id": "string",
      "script_template_id": null,
      "name": "string",
      "description": "string",
      "language": "string",
      "ai_created": false
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Create Script

post

Creates a new script.

Authorizations

AuthorizationstringRequired

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

Body

descriptionstring · max: 255 · nullableOptional

languagestringRequired

ai_createdstring · nullableOptional

namestring · max: 255Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post/api/v1/scripts

POST /api/v1/scripts HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "name": "string",
  "description": "string",
  "language": "string",
  "ai_created": false
}

{
  "data": {
    "id": "string",
    "script_template_id": null,
    "name": "string",
    "description": "string",
    "language": "string",
    "ai_created": false
  }
}

Get Script

get

Retrieves the details of a specific script.

Authorizations

AuthorizationstringRequired

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

Path parameters

scriptstringRequired

The script identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[versions.id]stringOptional

Filter results by versions.id.

includestringOptional

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

sortstringOptional

Sort field. Prefix with - for descending. Available: name

fields[versions]stringOptional

Comma-separated list of versions fields to return. Available: id, script_id, version, name, deployed_at, deployment_failed_at, deploying, deployment_failure_reason

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}

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

{
  "data": {
    "id": "string",
    "script_template_id": null,
    "name": "string",
    "description": "string",
    "language": "string",
    "ai_created": false
  }
}

Update Script

put

Updates an existing script.

Authorizations

AuthorizationstringRequired

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

Path parameters

scriptstringRequired

The script identifier.

Body

descriptionstring · max: 255 · nullableOptional

languagestringOptional

valuestring · min: 1Optional

namestring · max: 255Optional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put/api/v1/scripts/{script}

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

{
  "name": "string",
  "description": "string",
  "language": "string",
  "value": "string"
}

{
  "data": {
    "id": "string",
    "script_template_id": null,
    "name": "string",
    "description": "string",
    "language": "string",
    "ai_created": false
  }
}

Delete Script

delete

Permanently deletes a specific script.

Authorizations

AuthorizationstringRequired

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

Path parameters

scriptstringRequired

The script identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete/api/v1/scripts/{script}

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

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