DemoGitHubDiscord Server

Docker

Manage Team docker resources for servers.

Get server stacks list.

get

Requires View Server and View Stack permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/stacks HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": [
    {
      "id": "text",
      "name": "text",
      "created_at": "2025-06-22T22:17:42.819Z",
      "updated_at": "2025-06-22T22:17:42.819Z",
      "version": 1,
      "type": 0,
      "control_type": 0,
      "containers_count": 1,
      "is_running": true,
      "containers": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "image_id": "text",
          "image_name": "text",
          "stack_id": "text",
          "stack_name": "text",
          "status": "text",
          "state": "text",
          "created_at": "2025-06-22T22:17:42.819Z",
          "is_running": true,
          "is_paused": true,
          "is_restarting": true,
          "details": {
            "command": "text",
            "entrypoint": "text",
            "working_directory": "text",
            "platform": "text",
            "network": "text",
            "isOOMDisabled": true,
            "isPrivileged": true,
            "isReadOnly": true,
            "networkDisabled": true
          },
          "labels": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "environment": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "health": {
            "started_at": {
              "utc": "2025-06-22T22:17:42.819Z",
              "unix": 1
            },
            "stopped_at": {
              "utc": "2025-06-22T22:17:42.819Z",
              "unix": 1
            },
            "error": "text",
            "check": "text",
            "failures": 1,
            "log_json": "text"
          }
        }
      ]
    }
  ]
}

Get server containers list.

get

Requires View Server and View Container permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/containers HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "image_id": "text",
      "image_name": "text",
      "stack_id": "text",
      "stack_name": "text",
      "status": "text",
      "state": "text",
      "created_at": "2025-06-22T22:17:42.819Z",
      "is_running": true,
      "is_paused": true,
      "is_restarting": true,
      "details": {
        "command": "text",
        "entrypoint": "text",
        "working_directory": "text",
        "platform": "text",
        "network": "text",
        "isOOMDisabled": true,
        "isPrivileged": true,
        "isReadOnly": true,
        "networkDisabled": true
      },
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "environment": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "health": {
        "started_at": {
          "utc": "2025-06-22T22:17:42.819Z",
          "unix": 1
        },
        "stopped_at": {
          "utc": "2025-06-22T22:17:42.819Z",
          "unix": 1
        },
        "error": "text",
        "check": "text",
        "failures": 1,
        "log_json": "text"
      }
    }
  ]
}

Get server stack info.

get

Requires View Server and View Stack permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
stackIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/stacks/{stackId} HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": {
    "id": "text",
    "name": "text",
    "created_at": "2025-06-22T22:17:42.819Z",
    "updated_at": "2025-06-22T22:17:42.819Z",
    "version": 1,
    "type": 0,
    "control_type": 0,
    "containers_count": 1,
    "is_running": true,
    "containers": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "image_id": "text",
        "image_name": "text",
        "stack_id": "text",
        "stack_name": "text",
        "status": "text",
        "state": "text",
        "created_at": "2025-06-22T22:17:42.819Z",
        "is_running": true,
        "is_paused": true,
        "is_restarting": true,
        "details": {
          "command": "text",
          "entrypoint": "text",
          "working_directory": "text",
          "platform": "text",
          "network": "text",
          "isOOMDisabled": true,
          "isPrivileged": true,
          "isReadOnly": true,
          "networkDisabled": true
        },
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "environment": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "health": {
          "started_at": {
            "utc": "2025-06-22T22:17:42.819Z",
            "unix": 1
          },
          "stopped_at": {
            "utc": "2025-06-22T22:17:42.819Z",
            "unix": 1
          },
          "error": "text",
          "check": "text",
          "failures": 1,
          "log_json": "text"
        }
      }
    ]
  }
}

Delete a server stack.

delete

Requires View Server, View Stack and Manage Stack permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
stackIdstringRequiredDefault: ""
Responses
200
Success
application/json
delete
DELETE /api/servers/{serverId}/stacks/{stackId}/remove HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text"
}

Get server container info.

get

Requires View Server and View Containers permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
containerIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/containers/{containerId} HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": {
    "id": "text",
    "name": "text",
    "created_at": "2025-06-22T22:17:42.819Z",
    "updated_at": "2025-06-22T22:17:42.819Z",
    "version": 1,
    "type": 0,
    "control_type": 0,
    "containers_count": 1,
    "is_running": true,
    "containers": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "image_id": "text",
        "image_name": "text",
        "stack_id": "text",
        "stack_name": "text",
        "status": "text",
        "state": "text",
        "created_at": "2025-06-22T22:17:42.819Z",
        "is_running": true,
        "is_paused": true,
        "is_restarting": true,
        "details": {
          "command": "text",
          "entrypoint": "text",
          "working_directory": "text",
          "platform": "text",
          "network": "text",
          "isOOMDisabled": true,
          "isPrivileged": true,
          "isReadOnly": true,
          "networkDisabled": true
        },
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "environment": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "health": {
          "started_at": {
            "utc": "2025-06-22T22:17:42.819Z",
            "unix": 1
          },
          "stopped_at": {
            "utc": "2025-06-22T22:17:42.819Z",
            "unix": 1
          },
          "error": "text",
          "check": "text",
          "failures": 1,
          "log_json": "text"
        }
      }
    ]
  }
}

Control server container state.

patch

Requires View Server, View Container and Control Container permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
containerIdstringRequiredDefault: ""
Query parameters
typestring · enumRequiredPossible values:
Responses
200
Success
application/json
patch
PATCH /api/servers/{serverId}/containers/{containerId}/control HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text"
}

Rename a container.

post

Requires View Server, View Container and Manage Container permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
containerIdstringRequiredDefault: ""
Query parameters
namestringRequiredDefault: ""
Responses
200
Success
application/json
post
POST /api/servers/{serverId}/containers/{containerId}/rename HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text"
}

Get server container logs.

get

Requires View Server, View Container and View Container Logs permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
containerIdstringRequiredDefault: ""
Query parameters
limitinteger · int32OptionalDefault: 100
splitbooleanOptionalDefault: false
showTimestampbooleanOptionalDefault: false
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/containers/{containerId}/logs HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": [
    "text"
  ]
}

Get server container file system changes.

get

Requires View Server, View Container and View Container Changes permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
containerIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/containers/{containerId}/changes HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": [
    {
      "type": 0,
      "path": "text"
    }
  ]
}

Get server container stats.

get

Requires View Server, View Container and View Container Stats permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
containerIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/containers/{containerId}/stats HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": {
    "memory_usage": {
      "text": "text",
      "raw": 1,
      "nearest": 1
    },
    "io_read_total": {
      "text": "text",
      "raw": 1,
      "nearest": 1
    },
    "io_write_total": {
      "text": "text",
      "raw": 1,
      "nearest": 1
    },
    "cpu_usage": 1,
    "networks": {
      "ANY_ADDITIONAL_PROPERTY": {
        "network_transmit_total": {
          "text": "text",
          "raw": 1,
          "nearest": 1
        },
        "network_receive_total": {
          "text": "text",
          "raw": 1,
          "nearest": 1
        }
      }
    }
  }
}

Get server container processes.

get

Requires View Server, View Container and View Container Stats permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
containerIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/containers/{containerId}/processes HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": [
    {
      "user": "text",
      "process_id": 1,
      "parent_id": 1,
      "threads": 1,
      "total_cpu_usage": 1,
      "current_cpu_usage": 1,
      "current_memory_usage": 1,
      "start_time": "text",
      "elapsed_time": "text",
      "name": "text",
      "command": "text"
    }
  ]
}

Get server container full docker information.

get

Requires View Server and Docker Administrator permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
containerIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/containers/{containerId}/inspect HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": {
    "id": "text",
    "created": "2025-06-22T22:17:42.819Z",
    "path": "text",
    "args": [
      "text"
    ],
    "state": {
      "status": "text",
      "running": true,
      "paused": true,
      "restarting": true,
      "oomKilled": true,
      "dead": true,
      "pid": 1,
      "exitCode": 1,
      "error": "text",
      "startedAt": "text",
      "finishedAt": "text",
      "health": {
        "status": "text",
        "failingStreak": 1,
        "log": [
          {
            "start": "2025-06-22T22:17:42.819Z",
            "end": "2025-06-22T22:17:42.819Z",
            "exitCode": 1,
            "output": "text"
          }
        ]
      }
    },
    "image": "text",
    "resolvConfPath": "text",
    "hostnamePath": "text",
    "hostsPath": "text",
    "logPath": "text",
    "node": {
      "id": "text",
      "ipAddress": "text",
      "addr": "text",
      "name": "text",
      "cpus": 1,
      "memory": 1,
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "name": "text",
    "restartCount": 1,
    "driver": "text",
    "platform": "text",
    "mountLabel": "text",
    "processLabel": "text",
    "appArmorProfile": "text",
    "execIDs": [
      "text"
    ],
    "hostConfig": {
      "binds": [
        "text"
      ],
      "containerIDFile": "text",
      "logConfig": {
        "type": "text",
        "config": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "networkMode": "text",
      "portBindings": {
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "hostIP": "text",
            "hostPort": "text"
          }
        ]
      },
      "restartPolicy": {
        "name": 0,
        "maximumRetryCount": 1
      },
      "autoRemove": true,
      "volumeDriver": "text",
      "volumesFrom": [
        "text"
      ],
      "capAdd": [
        "text"
      ],
      "capDrop": [
        "text"
      ],
      "cgroupnsMode": "text",
      "dns": [
        "text"
      ],
      "dnsOptions": [
        "text"
      ],
      "dnsSearch": [
        "text"
      ],
      "extraHosts": [
        "text"
      ],
      "groupAdd": [
        "text"
      ],
      "ipcMode": "text",
      "cgroup": "text",
      "links": [
        "text"
      ],
      "oomScoreAdj": 1,
      "pidMode": "text",
      "privileged": true,
      "publishAllPorts": true,
      "readonlyRootfs": true,
      "securityOpt": [
        "text"
      ],
      "storageOpt": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "tmpfs": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "utsMode": "text",
      "usernsMode": "text",
      "shmSize": 1,
      "sysctls": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "runtime": "text",
      "consoleSize": [
        1
      ],
      "isolation": "text",
      "cpuShares": 1,
      "memory": 1,
      "nanoCPUs": 1,
      "cgroupParent": "text",
      "blkioWeight": 1,
      "blkioWeightDevice": [
        {
          "path": "text",
          "weight": 1
        }
      ],
      "blkioDeviceReadBps": [
        {
          "path": "text",
          "rate": 1
        }
      ],
      "blkioDeviceWriteBps": [
        {
          "path": "text",
          "rate": 1
        }
      ],
      "blkioDeviceReadIOps": [
        {
          "path": "text",
          "rate": 1
        }
      ],
      "blkioDeviceWriteIOps": [
        {
          "path": "text",
          "rate": 1
        }
      ],
      "cpuPeriod": 1,
      "cpuQuota": 1,
      "cpuRealtimePeriod": 1,
      "cpuRealtimeRuntime": 1,
      "cpusetCpus": "text",
      "cpusetMems": "text",
      "devices": [
        {
          "pathOnHost": "text",
          "pathInContainer": "text",
          "cgroupPermissions": "text"
        }
      ],
      "deviceCgroupRules": [
        "text"
      ],
      "deviceRequests": [
        {
          "driver": "text",
          "count": 1,
          "deviceIDs": [
            "text"
          ],
          "capabilities": [
            [
              "text"
            ]
          ],
          "options": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ],
      "kernelMemory": 1,
      "kernelMemoryTCP": 1,
      "memoryReservation": 1,
      "memorySwap": 1,
      "memorySwappiness": 1,
      "oomKillDisable": true,
      "pidsLimit": 1,
      "ulimits": [
        {
          "name": "text",
          "hard": 1,
          "soft": 1
        }
      ],
      "cpuCount": 1,
      "cpuPercent": 1,
      "ioMaximumIOps": 1,
      "ioMaximumBandwidth": 1,
      "mounts": [
        {
          "type": "text",
          "source": "text",
          "target": "text",
          "readOnly": true,
          "consistency": "text",
          "bindOptions": {
            "propagation": "text",
            "nonRecursive": true
          },
          "volumeOptions": {
            "noCopy": true,
            "labels": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "driverConfig": {
              "name": "text",
              "options": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            }
          },
          "tmpfsOptions": {
            "sizeBytes": 1,
            "mode": 1
          }
        }
      ],
      "maskedPaths": [
        "text"
      ],
      "readonlyPaths": [
        "text"
      ],
      "init": true
    },
    "graphDriver": {
      "data": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "name": "text"
    },
    "sizeRw": 1,
    "sizeRootFs": 1,
    "mounts": [
      {
        "type": "text",
        "name": "text",
        "source": "text",
        "destination": "text",
        "driver": "text",
        "mode": "text",
        "rw": true,
        "propagation": "text"
      }
    ],
    "config": {
      "hostname": "text",
      "domainname": "text",
      "user": "text",
      "attachStdin": true,
      "attachStdout": true,
      "attachStderr": true,
      "exposedPorts": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "tty": true,
      "openStdin": true,
      "stdinOnce": true,
      "env": [
        "text"
      ],
      "cmd": [
        "text"
      ],
      "healthcheck": {
        "test": [
          "text"
        ],
        "interval": "text",
        "timeout": "text",
        "startPeriod": 1,
        "retries": 1
      },
      "argsEscaped": true,
      "image": "text",
      "volumes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "workingDir": "text",
      "entrypoint": [
        "text"
      ],
      "networkDisabled": true,
      "macAddress": "text",
      "onBuild": [
        "text"
      ],
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "stopSignal": "text",
      "stopTimeout": "text",
      "shell": [
        "text"
      ]
    },
    "networkSettings": {
      "bridge": "text",
      "sandboxID": "text",
      "hairpinMode": true,
      "linkLocalIPv6Address": "text",
      "linkLocalIPv6PrefixLen": 1,
      "ports": {
        "ANY_ADDITIONAL_PROPERTY": [
          {
            "hostIP": "text",
            "hostPort": "text"
          }
        ]
      },
      "sandboxKey": "text",
      "secondaryIPAddresses": [
        {
          "addr": "text",
          "prefixLen": 1
        }
      ],
      "secondaryIPv6Addresses": [
        {
          "addr": "text",
          "prefixLen": 1
        }
      ],
      "endpointID": "text",
      "gateway": "text",
      "globalIPv6Address": "text",
      "globalIPv6PrefixLen": 1,
      "ipAddress": "text",
      "ipPrefixLen": 1,
      "iPv6Gateway": "text",
      "macAddress": "text",
      "networks": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ipamConfig": {
            "iPv4Address": "text",
            "iPv6Address": "text",
            "linkLocalIPs": [
              "text"
            ]
          },
          "links": [
            "text"
          ],
          "aliases": [
            "text"
          ],
          "networkID": "text",
          "endpointID": "text",
          "gateway": "text",
          "ipAddress": "text",
          "ipPrefixLen": 1,
          "iPv6Gateway": "text",
          "globalIPv6Address": "text",
          "globalIPv6PrefixLen": 1,
          "macAddress": "text",
          "driverOpts": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    }
  }
}

Delete a server container.

delete

Requires View Server, View Container and Manage Container permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
containerIdstringRequiredDefault: ""
Query parameters
forcebooleanOptionalDefault: false
Responses
200
Success
application/json
delete
DELETE /api/servers/{serverId}/containers/{containerId}/remove HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text"
}

Get server images list.

get

Requires View Server and View Image permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/images HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": [
    {
      "id": "text",
      "name": "text",
      "version": "text",
      "alt_version": "text",
      "created_at": "2025-06-22T22:17:42.819Z",
      "is_local": true,
      "is_parent": true,
      "parent": "text",
      "size": 1,
      "website": "text",
      "docs": "text",
      "source": "text",
      "repo_tags": [
        "text"
      ],
      "repo_digests": [
        "text"
      ],
      "docker_version": "text",
      "operating_system": "text",
      "operating_system_version": "text",
      "architecture": "text",
      "comment": "text",
      "driver": "text",
      "config": {
        "environment": [
          "text"
        ],
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "command": "text",
        "entrypoint": "text",
        "ports": [
          "text"
        ],
        "working_directory": "text"
      }
    }
  ]
}

Get a server image.

get

Requires View Server and View Image permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
imageIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/images/{imageId} HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": {
    "id": "text",
    "name": "text",
    "version": "text",
    "alt_version": "text",
    "created_at": "2025-06-22T22:17:42.819Z",
    "is_local": true,
    "is_parent": true,
    "parent": "text",
    "size": 1,
    "website": "text",
    "docs": "text",
    "source": "text",
    "repo_tags": [
      "text"
    ],
    "repo_digests": [
      "text"
    ],
    "docker_version": "text",
    "operating_system": "text",
    "operating_system_version": "text",
    "architecture": "text",
    "comment": "text",
    "driver": "text",
    "config": {
      "environment": [
        "text"
      ],
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "command": "text",
      "entrypoint": "text",
      "ports": [
        "text"
      ],
      "working_directory": "text"
    }
  }
}

Get server volumes list.

get

Requires View Server and View Volume permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/volumes HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": [
    {
      "name": "text",
      "created_at": "text",
      "driver": "text",
      "scope": "text",
      "mountpoint": "text",
      "status": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "options": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "containers": {
        "ANY_ADDITIONAL_PROPERTY": {
          "name": "text",
          "mounted_at": "text",
          "read_write": true
        }
      },
      "containers_list": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "containers_count": 1
    }
  ]
}

Get a server volume.

get

Requires View Server and View Volume permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
volumeIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/volumes/{volumeId} HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": {
    "name": "text",
    "created_at": "text",
    "driver": "text",
    "scope": "text",
    "mountpoint": "text",
    "status": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "options": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "containers": {
      "ANY_ADDITIONAL_PROPERTY": {
        "name": "text",
        "mounted_at": "text",
        "read_write": true
      }
    },
    "containers_list": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "containers_count": 1
  }
}

Get server networks list.

get

Requires View Server and View Network permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/networks HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": [
    {
      "id": "text",
      "name": "text",
      "driver": "text",
      "is_internal": true,
      "is_attachable": true,
      "scope": "text",
      "ingress": true,
      "config_only": true,
      "config_from": {
        "id": "text",
        "name": "text"
      },
      "created_at": "2025-06-22T22:17:42.819Z",
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "options": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "containers_list": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "containers_count": 1
    }
  ]
}

Get a server network.

get

Requires View Server and View Network permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
networkIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/networks/{networkId} HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": {
    "id": "text",
    "name": "text",
    "driver": "text",
    "is_internal": true,
    "is_attachable": true,
    "scope": "text",
    "ingress": true,
    "config_only": true,
    "config_from": {
      "id": "text",
      "name": "text"
    },
    "created_at": "2025-06-22T22:17:42.819Z",
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "options": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "containers_list": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "containers_count": 1
  }
}

Get server plugins list.

get

Requires View Server and View Plugin permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/plugins HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": [
    {
      "id": "text",
      "name": "text",
      "version": "text",
      "is_enabled": true,
      "reference": "text",
      "docker_version": "text",
      "description": "text",
      "url": "text",
      "documentation": "text",
      "working_directory": "text",
      "entrypoint": "text",
      "capabilities": [
        "text"
      ]
    }
  ]
}

Get a server plugins.

get

Requires View Server and View Plugin permissions.

Authorizations
Path parameters
serverIdstringRequiredDefault: ""
pluginIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/servers/{serverId}/plugins/{pluginId} HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": {
    "id": "text",
    "name": "text",
    "version": "text",
    "is_enabled": true,
    "reference": "text",
    "docker_version": "text",
    "description": "text",
    "url": "text",
    "documentation": "text",
    "working_directory": "text",
    "entrypoint": "text",
    "capabilities": [
      "text"
    ]
  }
}
PreviousConsoleNextMembers