Acknowledge database

Let Ploi know about databases created outside of the platform.

POST/api/servers/{server}/databases/acknowledge

Acknowledge a database

Sometimes applications create databases outside of Ploi. This endpoint allows you to inform Ploi about externally created databases so they appear in your dashboard.

Required attributes

Name
name
Type
string
Description
The database name. Allowed: alpha-numeric characters, dashes and underscores. Min: 2, Max: 64.

Request

POST

/api/servers/{server}/databases/acknowledge

curl -X POST "https://ploi.io/api/servers/{server}/databases/acknowledge" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "my_database"
  }'

Response

{
  "data": {
    "id": 1,
    "type": "mysql",
    "name": "my_database",
    "server_id": 1,
    "status": "created",
    "created_at": "2019-07-16 13:05:58"
  }
}