List server firewall rules

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/firewall-rules",
  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": "rules",
      "links": {
        "self": {
          "href": "<string>",
          "rel": "<string>",
          "describedby": "<string>",
          "title": "<string>",
          "type": "<string>",
          "hreflang": "<string>",
          "meta": {}
        }
      },
      "attributes": {
        "name": "<string>",
        "port": "<string>",
        "type": "<string>",
        "ip_address": "<string>",
        "status": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "path": "<string>",
    "per_page": 123,
    "next_cursor": "<string>",
    "prev_cursor": "<string>"
  }
}

GET

orgs

{organization}

servers

{server}

firewall-rules

List server firewall rules

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://forge.laravel.com/api/orgs/{organization}/servers/{server}/firewall-rules",
  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": "rules",
      "links": {
        "self": {
          "href": "<string>",
          "rel": "<string>",
          "describedby": "<string>",
          "title": "<string>",
          "type": "<string>",
          "hreflang": "<string>",
          "meta": {}
        }
      },
      "attributes": {
        "name": "<string>",
        "port": "<string>",
        "type": "<string>",
        "ip_address": "<string>",
        "status": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "path": "<string>",
    "per_page": 123,
    "next_cursor": "<string>",
    "prev_cursor": "<string>"
  }
}

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

Query Parameters

sort

string

Available sorts are 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: -created_at.

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[name]

string

The name of the firewall rule.

filter[status]

string

The status of the firewall rule.

filter[ip_address]

string

The IP address or subnet for the firewall rule.

filter[type]

string

The type of the firewall rule.

filter[port]

string

The port or port range for the firewall rule.

Response

Paginated set of RuleResource

data

RuleResource · object[]

required

Show child attributes

data.id

string

required

data.type

enum<string>

required

Available options:

rules

data.links

object

required

Show child attributes

data.links.self

Link · object

required

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

string

required

The name of the firewall rule.

data.attributes.port

string | null

required

The port or port range for the firewall rule.

data.attributes.type

string

required

The type of the firewall rule.

data.attributes.ip_address

string | null

required

The IP address or subnet for the firewall rule.

data.attributes.status

string | null

required

The status of the firewall rule.

data.attributes.created_at

string<date-time>

required

The date and time the firewall rule was created.

data.attributes.updated_at

string<date-time>

required

The date and time the firewall rule was last updated.

links

object

required

Show child attributes

links.first

string

links.last

string

links.prev

string

links.next

string

Introduction

Reference

List server firewall rules

Authorizations

Path Parameters

Query Parameters

Response