Update Environment

PATCH

/v1/environments/{id}

Update an environment's configuration.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Header Params

string

required

Example:

application/json

Content-Type

string

required

Example:

application/json

Body Params application/json

data

object

required

attributes

object

required

Example

{
  "data": {
    "attributes": {
      "title": "new name",
      "ssh": false,
      "sshPassword": "newPasswordSuperStrong",
      "sftp": false,
      "phpMemoryLimit": 256,
      "phpTimeZone": "Europe/Rome",
      "htaccessRoot": "none",
      "cacheMode": "none",
      "forceHTTPS": "domain.com",
      "forceDomain": {
        "https": true,
        "domain": "domain.com"
      },
      "environmentInfoFile": "json",
      "cloudflareLock": false,
      "phpVersion": "8.2",
      "phpExtensions": [
        85
      ]
    }
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.servebolt.io/v1/environments/' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "attributes": {
            "title": "new name",
            "ssh": false,
            "sshPassword": "newPasswordSuperStrong",
            "sftp": false,
            "phpMemoryLimit": 256,
            "phpTimeZone": "Europe/Rome",
            "htaccessRoot": "none",
            "cacheMode": "none",
            "forceHTTPS": "domain.com",
            "forceDomain": {
                "https": true,
                "domain": "domain.com"
            },
            "environmentInfoFile": "json",
            "cloudflareLock": false,
            "phpVersion": "8.2",
            "phpExtensions": [85]
        }
    }
}'

Responses

🟢200OK

application/json

Body

data

object

required

string

required

type

string

required

attributes

object

required

relationships

object

required

links

object

required

Example

{
  "data": {
    "id": "1803",
    "type": "environments",
    "attributes": {
      "title": "new name",
      "enabled": true,
      "hostname": "xxx",
      "ip": "185.91.65.xxx",
      "internalName": "newawe_1803",
      "internalUrl": "newawe-1803.xxx",
      "phpVersion": "8.2",
      "phpExtensions": [
        {
          "id": 85,
          "name": "ffi",
          "cli": true,
          "web": false
        }
      ],
      "phpWorkers": {
        "max": 128,
        "nice": 18,
        "maxRequests": 500
      },
      "domains": [],
      "state": "development",
      "storage": {
        "used": null,
        "total": 4096
      },
      "location": "Oslo, NO",
      "devMode": false,
      "apikey": "xxx",
      "isLegacy": false,
      "cloudflareLock": false,
      "cacheMode": "none",
      "environmentInfoFile": "json",
      "forceDomain": {
        "https": true,
        "domain": "domain.com"
      },
      "forceHTTPS": "domain.com",
      "phpMemoryLimit": 256,
      "htaccessRoot": "none",
      "ssh": false,
      "sftp": false,
      "phpTimezone": "UTC"
    },
    "relationships": {
      "bolt": {
        "data": {
          "id": "8988",
          "type": "bolts",
          "attributes": {
            "internalName": "wefwef_8988"
          }
        }
      }
    },
    "links": {
      "self": "https://xxx/v1/environments/1803"
    }
  }
}

Modified at 2024-10-30 14:22:17

Get Environment

Delete Environment