curl
curl -sS -X POST "https://gateway.orbit/api/v1/database-servers" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81' \
-H 'Content-Type: application/json' \
-d '{"slug": "acme", "node_id": 7, "tag": "8.4", "port": 3306}'{
"data": {
"id": 123,
"slug": "<string>",
"node_id": 123,
"process_id": 123,
"tag": "<string>",
"port": 123,
"status": "<string>",
"databases_count": 123
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"data": {
"id": 123,
"slug": "<string>",
"node_id": 123,
"process_id": 123,
"tag": "<string>",
"port": 123,
"status": "<string>",
"databases_count": 123
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Database connections
Create a Database server
Runs a MySQL server as a Docker Node Process. The Gateway generates the root password, passes it to the container for the first start only, and then keeps it only encrypted. A retry of the same request continues from the first step that did not finish; another Node, tag, or port for an existing slug returns database.server_slug_conflict. No response contains the password.
POST
/
api
/
v1
/
database-servers
curl
curl -sS -X POST "https://gateway.orbit/api/v1/database-servers" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81' \
-H 'Content-Type: application/json' \
-d '{"slug": "acme", "node_id": 7, "tag": "8.4", "port": 3306}'{
"data": {
"id": 123,
"slug": "<string>",
"node_id": 123,
"process_id": 123,
"tag": "<string>",
"port": 123,
"status": "<string>",
"databases_count": 123
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"data": {
"id": 123,
"slug": "<string>",
"node_id": 123,
"process_id": 123,
"tag": "<string>",
"port": 123,
"status": "<string>",
"databases_count": 123
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Body
application/json
Database server slug
Maximum string length:
63Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$(?![\s\S])Required range:
x >= 1MySQL image tag. Defaults to 8.4
Maximum string length:
128Pattern:
^[A-Za-z0-9_][A-Za-z0-9_.-]{0,127}$(?![\s\S])Port to publish on the Node WireGuard address. Defaults to 3306
Required range:
1 <= x <= 65535