Caches

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.

• flow

• flow_count

• flowExists

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.

• flow_id

• for_flow

• scope

• 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.

• caches.id

• caches.scope

• caches.ttl

• caches.created_at

• caches.updated_at

• caches.name

• caches.flow_id

• caches.cache_template_id

Authorizations

ApiKeyAuth

Query parameters

filter[flow_id]stringOptional

Filter results by flow_id.

filter[for_flow]stringOptional

Filter results by for_flow.

filter[scope]stringOptional

Filter results by scope.

filter[id]stringOptional

Filter results by id.

filter[,]stringOptional

Filter results by ,.

filter[name]stringOptional

Filter results by name.

filter[LIKE]stringOptional

Filter results by LIKE.

filter[flow]stringOptional

Filter results by flow.

includestringOptional

Comma-separated list of relationships to include. Available: flow

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/caches

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": 1,
      "scope": "example_scope",
      "ttl": "example_ttl",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "name": "My Example",
      "flow_id": 1,
      "cache_template_id": 1,
      "content": "example_content",
      "ttl_unit": "example_ttl_unit",
      "ttl_number": "example_ttl_number",
      "flow": "example_flow"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/caches",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/caches?page=1",
    "last": "https://api.example.com/api/v1/caches?page=1",
    "prev": null,
    "next": null
  }
}

Get Metadata

get

Get Metadata for metadata.

Authorizations

ApiKeyAuth

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get

/api/v1/caches/metadata

HTTPcURLJavaScriptPython

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

No content

Show

get

Get a single cache.

Authorizations

ApiKeyAuth

Path parameters

cachestringRequired

The cache identifier.

Query parameters

filter[flow_id]stringOptional

Filter results by flow_id.

filter[for_flow]stringOptional

Filter results by for_flow.

filter[scope]stringOptional

Filter results by scope.

filter[id]stringOptional

Filter results by id.

filter[,]stringOptional

Filter results by ,.

filter[name]stringOptional

Filter results by name.

filter[LIKE]stringOptional

Filter results by LIKE.

filter[flow]stringOptional

Filter results by flow.

includestringOptional

Comma-separated list of relationships to include. Available: flow

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/caches/{cache}

HTTPcURLJavaScriptPython

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

{
  "data": {
    "id": 1,
    "scope": "example_scope",
    "ttl": "example_ttl",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "flow_id": 1,
    "cache_template_id": 1,
    "content": "example_content",
    "ttl_unit": "example_ttl_unit",
    "ttl_number": "example_ttl_number",
    "flow": "example_flow"
  }
}

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	☑
ttl_unit
ttl_number

Authorizations

ApiKeyAuth

Path parameters

cachestringRequired

The cache identifier.

Body

application/json

ttl_unitstring · nullableOptional

ttl_numberstring · nullableOptional

namestringRequired

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/caches/{cache}

HTTPcURLJavaScriptPython

PUT /api/v1/caches/{cache} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "ttl_unit": "example_ttl_unit",
  "ttl_number": "example_ttl_number",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "scope": "example_scope",
    "ttl": "example_ttl",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "flow_id": 1,
    "cache_template_id": 1,
    "content": "example_content",
    "ttl_unit": "example_ttl_unit",
    "ttl_number": "example_ttl_number",
    "flow": "example_flow"
  }
}

Destroy

delete

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
cache_id

Authorizations

ApiKeyAuth

Path parameters

cachestringRequired

The cache identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/caches/{cache}

HTTPcURLJavaScriptPython

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

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

Get Content

get

Get Content for content.

Authorizations

ApiKeyAuth

Path parameters

cachestringRequired

The cache identifier.

keystringRequired

The key identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get

/api/v1/caches/{cache}/content/{key}

HTTPcURLJavaScriptPython

GET /api/v1/caches/{cache}/content/{key} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

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

Authorizations

ApiKeyAuth

Path parameters

cachestringRequired

The cache identifier.

keystringRequired

The key identifier.

Body

application/json

contentstring · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/caches/{cache}/content/{key}

HTTPcURLJavaScriptPython

PUT /api/v1/caches/{cache}/content/{key} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "content": "example_content"
}

{
  "data": {
    "id": 1,
    "scope": "example_scope",
    "ttl": "example_ttl",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "flow_id": 1,
    "cache_template_id": 1,
    "content": "example_content",
    "ttl_unit": "example_ttl_unit",
    "ttl_number": "example_ttl_number",
    "flow": "example_flow"
  }
}

Flush

post

Flush for flush.

Authorizations

ApiKeyAuth

Path parameters

cachestringRequired

The cache identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/caches/{cache}/flush

HTTPcURLJavaScriptPython

POST /api/v1/caches/{cache}/flush HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

Search

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

Authorizations

ApiKeyAuth

Path parameters

cachestringRequired

The cache identifier.

searchstringRequired

The search identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get

/api/v1/caches/{cache}/search/{search}

HTTPcURLJavaScriptPython

GET /api/v1/caches/{cache}/search/{search} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}