{
  "opencollection": "1.0.0",
  "info": {
    "name": "Laravel Cloud Applications Background Processes API",
    "version": "0.0.1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Background Processes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List background processes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.laravel.com/api/instances/:instance/background-processes",
            "params": [
              {
                "name": "instance",
                "value": "",
                "type": "path",
                "description": "The instance identifier"
              },
              {
                "name": "include",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get a list of all background processes for the given instance."
        },
        {
          "info": {
            "name": "Create background process",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cloud.laravel.com/api/instances/:instance/background-processes",
            "params": [
              {
                "name": "instance",
                "value": "",
                "type": "path",
                "description": "The instance identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new background process for an instance."
        },
        {
          "info": {
            "name": "Get background process",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.laravel.com/api/background-processes/:backgroundProcess",
            "params": [
              {
                "name": "backgroundProcess",
                "value": "",
                "type": "path",
                "description": "The background process identifier"
              },
              {
                "name": "include",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get the details of a specific background process."
        },
        {
          "info": {
            "name": "Update background process",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://cloud.laravel.com/api/background-processes/:backgroundProcess",
            "params": [
              {
                "name": "backgroundProcess",
                "value": "",
                "type": "path",
                "description": "The background process identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a background process."
        },
        {
          "info": {
            "name": "Delete background process",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://cloud.laravel.com/api/background-processes/:backgroundProcess",
            "params": [
              {
                "name": "backgroundProcess",
                "value": "",
                "type": "path",
                "description": "The background process identifier"
              }
            ]
          },
          "docs": "Delete a background process."
        },
        {
          "info": {
            "name": "List background processes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.laravel.com/api/orgs/:organization/servers/:server/background-processes",
            "params": [
              {
                "name": "organization",
                "value": "",
                "type": "path",
                "description": "The organization slug"
              },
              {
                "name": "server",
                "value": "",
                "type": "path",
                "description": "The server ID"
              },
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "The number of results that will be returned per page."
              },
              {
                "name": "page[cursor]",
                "value": "",
                "type": "query",
                "description": "The cursor to start the pagination from."
              },
              {
                "name": "filter[user]",
                "value": "",
                "type": "query",
                "description": "The user that the process is running as."
              },
              {
                "name": "filter[site_id]",
                "value": "",
                "type": "query",
                "description": "The site ID that the process is running for."
              },
              {
                "name": "filter[directory]",
                "value": "",
                "type": "query",
                "description": "The directory that the process is running in."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List all background processes on the server.\n\nProcessing mode: <small><code>sync</code></small>"
        },
        {
          "info": {
            "name": "Create background process",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cloud.laravel.com/api/orgs/:organization/servers/:server/background-processes",
            "params": [
              {
                "name": "organization",
                "value": "",
                "type": "path",
                "description": "The organization slug"
              },
              {
                "name": "server",
                "value": "",
                "type": "path",
                "description": "The server ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new background process from a template.\n\nProcessing mode: <small><code>async</code></small>"
        },
        {
          "info": {
            "name": "Get background process",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.laravel.com/api/orgs/:organization/servers/:server/background-processes/:backgroundProcess",
            "params": [
              {
                "name": "organization",
                "value": "",
                "type": "path",
                "description": "The organization slug"
              },
              {
                "name": "server",
                "value": "",
                "type": "path",
                "description": "The server ID"
              },
              {
                "name": "backgroundProcess",
                "value": "",
                "type": "path",
                "description": "The background process ID"
              }
            ]
          },
          "docs": "\n\nProcessing mode: <small><code>sync</code></small>"
        },
        {
          "info": {
            "name": "Update background process",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://cloud.laravel.com/api/orgs/:organization/servers/:server/background-processes/:backgroundProcess",
            "params": [
              {
                "name": "organization",
                "value": "",
                "type": "path",
                "description": "The organization slug"
              },
              {
                "name": "server",
                "value": "",
                "type": "path",
                "description": "The server ID"
              },
              {
                "name": "backgroundProcess",
                "value": "",
                "type": "path",
                "description": "The background process ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the supervisor configuration for a background process.\n\nProcessing mode: <small><code>async</code></small>"
        },
        {
          "info": {
            "name": "Delete background process",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://cloud.laravel.com/api/orgs/:organization/servers/:server/background-processes/:backgroundProcess",
            "params": [
              {
                "name": "organization",
                "value": "",
                "type": "path",
                "description": "The organization slug"
              },
              {
                "name": "server",
                "value": "",
                "type": "path",
                "description": "The server ID"
              },
              {
                "name": "backgroundProcess",
                "value": "",
                "type": "path",
                "description": "The background process ID"
              }
            ]
          },
          "docs": "\n\nProcessing mode: <small><code>async</code></small>"
        },
        {
          "info": {
            "name": "Get background process log",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cloud.laravel.com/api/orgs/:organization/servers/:server/background-processes/:backgroundProcess/log",
            "params": [
              {
                "name": "organization",
                "value": "",
                "type": "path",
                "description": "The organization slug"
              },
              {
                "name": "server",
                "value": "",
                "type": "path",
                "description": "The server ID"
              },
              {
                "name": "backgroundProcess",
                "value": "",
                "type": "path",
                "description": "The background process ID"
              }
            ]
          },
          "docs": "\n\nProcessing mode: <small><code>sync</code></small>"
        }
      ]
    }
  ],
  "bundled": true
}