Packages

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

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.

• createdBy

• createdBy_count

• createdByExists

• flowVersions

• flowVersions_count

• flowVersionsExists

• virtualEnvironments

• virtualEnvironments_count

• virtualEnvironmentsExists

• deployments

• deployments_count

• deploymentsExists

• deployments.virtualEnvironment

• deployments.virtualEnvironment.deployedVersion

• deployments.user

• package

• package_count

• packageExists

• flowVersionDeployments

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.

• name

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

• packages.id

• packages.name

• packages.notes

• packages.created_by

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

• name

Authorizations

ApiKeyAuth

Query parameters

filter[name]stringOptional

Filter results by name.

includestringOptional

Comma-separated list of relationships to include. Available: createdBy, flowVersions.deployments, virtualEnvironments, deployments.virtualEnvironment.deployedVersion, deployments.user, package, flowVersionDeployments, flowVersionDeployments, flowVersionDeployments

sortstringOptional

Sort field. Prefix with - for descending. Available: 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

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/packages

HTTPcURLJavaScriptPython

GET /api/v1/packages HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "My Example",
      "notes": "example_notes",
      "created_by": "example_created_by",
      "priority": 1,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "created_by_user": [],
      "flow_versions": [],
      "virtual_environments": [],
      "deployments": [],
      "flow_versions_count": 5,
      "deployments_count": 5,
      "flow_version_deployments_count": 5
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/packages",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/packages?page=1",
    "last": "https://api.example.com/api/v1/packages?page=1",
    "prev": null,
    "next": null
  }
}

Store

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
name	string	☑
notes	string

Authorizations

ApiKeyAuth

Body

application/json

notesstring · max: 255 · nullableOptional

namestring · max: 255Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/packages

HTTPcURLJavaScriptPython

POST /api/v1/packages HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "notes": "example_notes",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "name": "My Example",
    "notes": "example_notes",
    "created_by": "example_created_by",
    "priority": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "created_by_user": [],
    "flow_versions": [],
    "virtual_environments": [],
    "deployments": [],
    "flow_versions_count": 5,
    "deployments_count": 5,
    "flow_version_deployments_count": 5
  }
}

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.

• createdBy

• createdBy_count

• createdByExists

• flowVersions

• flowVersions_count

• flowVersionsExists

• virtualEnvironments

• virtualEnvironments_count

• virtualEnvironmentsExists

• deployments

• deployments_count

• deploymentsExists

• deployments.virtualEnvironment

• deployments.virtualEnvironment.deployedVersion

• deployments.user

• package

• package_count

• packageExists

• flowVersionDeployments

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.

• name

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

• packages.id

• packages.name

• packages.notes

• packages.created_by

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

• name

Authorizations

ApiKeyAuth

Path parameters

packagestringRequired

The package identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

includestringOptional

Comma-separated list of relationships to include. Available: createdBy, flowVersions.deployments, virtualEnvironments, deployments.virtualEnvironment.deployedVersion, deployments.user, package, flowVersionDeployments, flowVersionDeployments, flowVersionDeployments

sortstringOptional

Sort field. Prefix with - for descending. Available: 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

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/packages/{package}

HTTPcURLJavaScriptPython

GET /api/v1/packages/{package} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "name": "My Example",
    "notes": "example_notes",
    "created_by": "example_created_by",
    "priority": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "created_by_user": [],
    "flow_versions": [],
    "virtual_environments": [],
    "deployments": [],
    "flow_versions_count": 5,
    "deployments_count": 5,
    "flow_version_deployments_count": 5
  }
}

Update

put

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
name	string
notes	string

Authorizations

ApiKeyAuth

Path parameters

packagestringRequired

The package identifier.

Body

application/json

notesstring · max: 255 · nullableOptional

namestring · max: 255Optional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/packages/{package}

HTTPcURLJavaScriptPython

PUT /api/v1/packages/{package} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "notes": "example_notes",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "name": "My Example",
    "notes": "example_notes",
    "created_by": "example_created_by",
    "priority": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "created_by_user": [],
    "flow_versions": [],
    "virtual_environments": [],
    "deployments": [],
    "flow_versions_count": 5,
    "deployments_count": 5,
    "flow_version_deployments_count": 5
  }
}

Destroy

delete

Delete a package.

Authorizations

ApiKeyAuth

Path parameters

packagestringRequired

The package identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/packages/{package}

HTTPcURLJavaScriptPython

DELETE /api/v1/packages/{package} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

Compare

get

Compare for compare.

Authorizations

ApiKeyAuth

Path parameters

packagestringRequired

The package identifier.

virtual_environmentstringRequired

The virtual environment identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get

/api/v1/packages/{package}/compare/{virtual_environment}

HTTPcURLJavaScriptPython

GET /api/v1/packages/{package}/compare/{virtual_environment} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

Deploy

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
notes	string

Authorizations

ApiKeyAuth

Path parameters

packagestringRequired

The package identifier.

virtual_environmentstringRequired

The virtual environment identifier.

Body

application/json

notesstringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/packages/{package}/deploy/{virtual_environment}

HTTPcURLJavaScriptPython

POST /api/v1/packages/{package}/deploy/{virtual_environment} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "notes": "example_notes"
}

{}

Store

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
priority	integer

Authorizations

ApiKeyAuth

Path parameters

packagestringRequired

The package identifier.

flow_versionstringRequired

The flow version identifier.

Body

application/json

priorityinteger · min: 1 · max: 100 · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/packages/{package}/flow-versions/{flow_version}

HTTPcURLJavaScriptPython

POST /api/v1/packages/{package}/flow-versions/{flow_version} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "priority": 1
}

{
  "data": {
    "id": 1,
    "virtual_environment_id": 1,
    "flow_version_id": 1,
    "priority": 1,
    "cron_string": "example_cron_string",
    "microservice": "example_microservice",
    "config": "example_config",
    "flow_step_route_id": 1,
    "variables": "example_variables",
    "parent_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "enabled_at": "2025-01-15T10:30:00.000000Z",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_id": 1,
    "flow_name": "example_flow_name",
    "flow_priority": "example_flow_priority",
    "iteration": "example_iteration",
    "status": "Draft",
    "is_deployed": true,
    "is_editable": true,
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": {},
    "deployed_by_user": {},
    "deployments": [],
    "has_callback_step": [],
    "steps": [],
    "runs": "example_runs",
    "latest_run": "example_latest_run",
    "schedules": "example_schedules",
    "filters": [],
    "steps_count": 5,
    "pivot": "example_pivot"
  }
}

Destroy

delete

Delete a flow version.

Authorizations

ApiKeyAuth

Path parameters

packagestringRequired

The package identifier.

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/packages/{package}/flow-versions/{flow_version}

HTTPcURLJavaScriptPython

DELETE /api/v1/packages/{package}/flow-versions/{flow_version} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

Destroy

delete

Delete a virtual environment.

Authorizations

ApiKeyAuth

Path parameters

packagestringRequired

The package identifier.

virtual_environmentstringRequired

The virtual environment identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/packages/{package}/virtual-environments/{virtual_environment}

HTTPcURLJavaScriptPython

DELETE /api/v1/packages/{package}/virtual-environments/{virtual_environment} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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