Cache Step

Index

get

List all cache step.

Authorizations

ApiKeyAuth

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/cache-step

HTTPcURLJavaScriptPython

GET /api/v1/cache-step HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "scope": "example_scope",
      "flow_id": 1,
      "ttl_unit": "example_ttl_unit",
      "ttl_number": "example_ttl_number",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/cache-step",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/cache-step?page=1",
    "last": "https://api.example.com/api/v1/cache-step?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	☑
scope		☑
flow_id
ttl_unit
ttl_number

Authorizations

ApiKeyAuth

Body

application/json

scopestringRequired

flow_idstringOptional

ttl_unitstringOptional

ttl_numberstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/cache-step

HTTPcURLJavaScriptPython

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

{
  "scope": "example_scope",
  "flow_id": 1,
  "ttl_unit": "example_ttl_unit",
  "ttl_number": "example_ttl_number"
}

{
  "data": {
    "id": 1,
    "scope": "example_scope",
    "flow_id": 1,
    "ttl_unit": "example_ttl_unit",
    "ttl_number": "example_ttl_number",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Show

get

Get a single cache step.

Authorizations

ApiKeyAuth

Path parameters

cache_stepstringRequired

The cache step identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get

/api/v1/cache-step/{cache_step}

HTTPcURLJavaScriptPython

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

No content