List commands

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites/{site}/commands",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "id": "<string>",
      "type": "commands",
      "links": {
        "self": {
          "href": "<string>",
          "rel": "<string>",
          "describedby": "<string>",
          "title": "<string>",
          "type": "<string>",
          "hreflang": "<string>",
          "meta": {}
        }
      },
      "attributes": {
        "command": "<string>",
        "status": "waiting",
        "duration": "<string>",
        "user_id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "user": {
          "data": {
            "type": "users",
            "id": "<string>"
          }
        }
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "path": "<string>",
    "per_page": 123,
    "next_cursor": "<string>",
    "prev_cursor": "<string>"
  },
  "included": [
    {
      "id": "<string>",
      "type": "users",
      "links": {
        "self": {
          "href": "<string>",
          "rel": "<string>",
          "describedby": "<string>",
          "title": "<string>",
          "type": "<string>",
          "hreflang": "<string>",
          "meta": {}
        }
      },
      "attributes": {
        "name": "<string>",
        "email": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

GET

orgs

{organization}

servers

{server}

sites

{site}

commands

List commands

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/sites/{site}/commands",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": [
    {
      "id": "<string>",
      "type": "commands",
      "links": {
        "self": {
          "href": "<string>",
          "rel": "<string>",
          "describedby": "<string>",
          "title": "<string>",
          "type": "<string>",
          "hreflang": "<string>",
          "meta": {}
        }
      },
      "attributes": {
        "command": "<string>",
        "status": "waiting",
        "duration": "<string>",
        "user_id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "user": {
          "data": {
            "type": "users",
            "id": "<string>"
          }
        }
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "path": "<string>",
    "per_page": 123,
    "next_cursor": "<string>",
    "prev_cursor": "<string>"
  },
  "included": [
    {
      "id": "<string>",
      "type": "users",
      "links": {
        "self": {
          "href": "<string>",
          "rel": "<string>",
          "describedby": "<string>",
          "title": "<string>",
          "type": "<string>",
          "hreflang": "<string>",
          "meta": {}
        }
      },
      "attributes": {
        "name": "<string>",
        "email": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organization

string

required

The organization slug

server

integer

required

The server ID

site

integer

required

The site ID

Query Parameters

sort

string

Available sorts are status, created_at, updated_at. You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -status.

page[size]

integer

default:30

The number of results that will be returned per page.

page[cursor]

string

The cursor to start the pagination from.

filter[user_id]

string

The user ID of the command initiator.

filter[status]

string

The status of the command.

filter[command]

string

The command it ran.

Response

Paginated set of CommandResource

data

CommandResource · object[]

required

Show child attributes

data.id

string

required

data.type

enum<string>

required

Available options:

commands

data.links

object

required

Show child attributes

data.links.self

Link · object

required

A link to the resource itself

Show child attributes

data.links.self.href

string<uri>

required

data.links.self.rel

string

data.links.self.describedby

string

data.links.self.title

string

data.links.self.type

string

data.links.self.hreflang

data.links.self.meta

object

data.attributes

object

Show child attributes

data.attributes.command

string

required

The command that ran.

data.attributes.status

enum<string>

required

The status of the command.

Available options:

waiting,

running,

finished,

timeout,

failed

data.attributes.duration

string

required

The duration of the command in human-readable format.

data.attributes.user_id

integer

required

The ID of the user who initiated the command.

data.attributes.created_at

string<date-time>

required

The date and time the command was created.

data.attributes.updated_at

string<date-time>

required

The date and time the command was last updated.

data.relationships

object

Show child attributes

data.relationships.user

object

The user who initiated the command.

Show child attributes

data.relationships.user.data

UserResourceIdentifier · object

required

Show child attributes

data.relationships.user.data.type

enum<string>

required

Available options:

users

data.relationships.user.data.id

string

required

links

object

required

Show child attributes

links.first

string

links.last

string

links.prev

string

links.next

string

Introduction

Reference

List commands

Authorizations

Path Parameters

Query Parameters

Response