SecureEdge API

The SecureEdge API can be used to programmatically interact with the SecureEdge, for example to get configuration details, make configuration changes, or create and manage Docker containers.

The SecureEdge API follows a REST interface, so you can GET, POST, or DELETE resources.

Example of a successful response, where the body contains the requested resource:

GET /api/v1/docker/images HTTP/1.1
Host: 192.168.140.1
User-Agent: curl/7.88.1
Accept: */*
Cookie: id=KjS1NvvocgJsUT+DTBxAeqqlbVDIxWO/Kx7B7U4Gngk=f2n-J1xC6tdydlvoQSVmyg

HTTP/1.1 200 OK
content-type: application/json
content-length: 33
date: Thu, 19 Dec 2024 13:16:12 GMT

[{"name":"nginx","tag":"latest"}]

Example of an unsuccessful response, where the body is in plain text with a summary of the error that occurred:

GET /api/v1/docker/images HTTP/1.1
Host: 192.168.140.1
User-Agent: curl/7.88.1
Accept: */*
Cookie: id=KjS1NvvocgJsUT+DTBxAeqqlbVDIxWO/Kx7B7U4Gngk=f2n-J1xC6tdydlvoQSVmyg

HTTP/1.1 500 Internal Server Error
content-type: text/plain; charset=utf-8
content-length: 47
date: Thu, 19 Dec 2024 13:13:21 GMT

an error occurred while interacting with Docker