Client

Get a specific server for a client

get

Fetch a server by its UUID for a specific client.

Authorizations

X-API-KeystringRequired

Path parameters

clientIdintegerRequired

ID of the client

Example: 42

serverUuidstring · uuidRequired

UUID of the server

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Successful operation

application/json

401

Unauthenticated

404

Server not found

application/json

get/api/v1/client/{clientId}/server/{serverUuid}

GET /api/v1/client/{clientId}/server/{serverUuid} HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "server": {
    "metal_server_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "inventory_id": 5678,
    "instance_type": {
      "id": 129,
      "name": "bm7.std.8"
    },
    "location": {
      "id": 18,
      "name": "EU: Rotterdam"
    },
    "created_at": "2024-01-01 12:00:00",
    "updated_at": "2024-01-01 12:00:00",
    "client": {
      "id": 42,
      "username": "john.doe@i3d.net"
    },
    "contract_id": "MY-CONTRACT-ID",
    "name": "my-server-name.example.com",
    "status": "delivered",
    "status_message": "No server discovered.",
    "os": {
      "id": 9,
      "slug": "debian-9",
      "name": "debian",
      "version": "9"
    },
    "ip_addresses": [
      {
        "ip_address": "127.0.0.1"
      }
    ],
    "tags": [
      "env:prod"
    ],
    "delivered_at": "2024-01-01 12:00:00",
    "released_at": "2024-01-01 12:00:00",
    "request_id": 1234,
    "client_server_request": {}
  }
}

Delete a specific server for a client

delete

Delete a server by its UUID for a specific client. The server must not be released already.

Authorizations

X-API-KeystringRequired

Path parameters

clientIdintegerRequired

ID of the client

Example: 42

serverUuidstring · uuidRequired

UUID of the server

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Release of server succesful

application/json

401

Unauthenticated

404

Server not found

application/json

delete/api/v1/client/{clientId}/server/{serverUuid}

DELETE /api/v1/client/{clientId}/server/{serverUuid} HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "server": {
    "metal_server_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "inventory_id": 5678,
    "instance_type": {
      "id": 129,
      "name": "bm7.std.8"
    },
    "location": {
      "id": 18,
      "name": "EU: Rotterdam"
    },
    "created_at": "2024-01-01 12:00:00",
    "updated_at": "2024-01-01 12:00:00",
    "client": {
      "id": 42,
      "username": "john.doe@i3d.net"
    },
    "contract_id": "MY-CONTRACT-ID",
    "name": "my-server-name.example.com",
    "status": "delivered",
    "status_message": "No server discovered.",
    "os": {
      "id": 9,
      "slug": "debian-9",
      "name": "debian",
      "version": "9"
    },
    "ip_addresses": [
      {
        "ip_address": "127.0.0.1"
      }
    ],
    "tags": [
      "env:prod"
    ],
    "delivered_at": "2024-01-01 12:00:00",
    "released_at": "2024-01-01 12:00:00",
    "request_id": 1234,
    "client_server_request": {}
  }
}

List servers for a specific client

get

Retrieve a list of servers for a specific client with pagination.

Authorizations

X-API-KeystringRequired

Path parameters

clientIdintegerRequired

ID of the client

Example: 42

Query parameters

pageintegerOptional

Page number for pagination

Example: 1

limitintegerOptional

Number of items per page

Example: 15

filterstringOptional

Filters for server listing (e.g., status)

Example: status=delivered&tag[]=tag1&tag[]=tag2

Responses

200

Successful operation

application/json

401

Unauthenticated

404

Client not found

get/api/v1/client/{clientId}/server

GET /api/v1/client/{clientId}/server HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "servers": [
    {
      "metal_server_uuid": "550e8400-e29b-41d4-a716-446655440000",
      "inventory_id": 5678,
      "instance_type": {
        "id": 129,
        "name": "bm7.std.8"
      },
      "location": {
        "id": 18,
        "name": "EU: Rotterdam"
      },
      "created_at": "2024-01-01 12:00:00",
      "updated_at": "2024-01-01 12:00:00",
      "client": {
        "id": 42,
        "username": "john.doe@i3d.net"
      },
      "contract_id": "MY-CONTRACT-ID",
      "name": "my-server-name.example.com",
      "status": "delivered",
      "status_message": "No server discovered.",
      "os": {
        "id": 9,
        "slug": "debian-9",
        "name": "debian",
        "version": "9"
      },
      "ip_addresses": [
        {
          "ip_address": "127.0.0.1"
        }
      ],
      "tags": [
        "env:prod"
      ],
      "delivered_at": "2024-01-01 12:00:00",
      "released_at": "2024-01-01 12:00:00",
      "request_id": 1234,
      "client_server_request": {}
    }
  ],
  "paginator": {
    "from": "1",
    "to": "10",
    "total": "20",
    "current_page": "1",
    "last_page": "1",
    "first_page_url": "http://localhost:8100/api/v1/servers/1?page=1",
    "prev_page_url": null,
    "next_page_url": "http://localhost:8100/api/v1/orders/1?page=2",
    "last_page_url": "http://localhost:8100/api/v1/orders/1?page=3",
    "path": "http://localhost:8100/api/v1/orders/1",
    "per_page": "10"
  }
}

Add a tag to a specific client server

post

Add a tag to a specific client server.

Authorizations

X-API-KeystringRequired

Path parameters

clientIdintegerRequired

ID of the client

Example: 42

serverUuidstring · uuidRequired

UUID of the server

Example: 550e8400-e29b-41d4-a716-446655440000

tagstringRequired

The tag to add

Example: my_tagPattern: ^[A-Za-z0-9_:-]{1,64}$

Responses

200

Successful operation

application/json

401

Unauthenticated

404

Client server not found

post/api/v1/client/{clientId}/server/{serverUuid}/tag/{tag}

POST /api/v1/client/{clientId}/server/{serverUuid}/tag/{tag} HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "server": {
    "metal_server_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "inventory_id": 5678,
    "instance_type": {
      "id": 129,
      "name": "bm7.std.8"
    },
    "location": {
      "id": 18,
      "name": "EU: Rotterdam"
    },
    "created_at": "2024-01-01 12:00:00",
    "updated_at": "2024-01-01 12:00:00",
    "client": {
      "id": 42,
      "username": "john.doe@i3d.net"
    },
    "contract_id": "MY-CONTRACT-ID",
    "name": "my-server-name.example.com",
    "status": "delivered",
    "status_message": "No server discovered.",
    "os": {
      "id": 9,
      "slug": "debian-9",
      "name": "debian",
      "version": "9"
    },
    "ip_addresses": [
      {
        "ip_address": "127.0.0.1"
      }
    ],
    "tags": [
      "env:prod"
    ],
    "delivered_at": "2024-01-01 12:00:00",
    "released_at": "2024-01-01 12:00:00",
    "request_id": 1234,
    "client_server_request": {}
  }
}

Remove a tag from a specific client server

delete

Remove a tag from a specific client server.

Authorizations

X-API-KeystringRequired

Path parameters

clientIdintegerRequired

ID of the client

Example: 42

serverUuidstring · uuidRequired

UUID of the server

Example: 550e8400-e29b-41d4-a716-446655440000

tagstringRequired

The tag to remove

Example: my_tagPattern: ^[A-Za-z0-9_:-]{1,64}$

Responses

200

Successful operation

application/json

401

Unauthenticated

404

Client server not found

delete/api/v1/client/{clientId}/server/{serverUuid}/tag/{tag}

DELETE /api/v1/client/{clientId}/server/{serverUuid}/tag/{tag} HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "server": {
    "metal_server_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "inventory_id": 5678,
    "instance_type": {
      "id": 129,
      "name": "bm7.std.8"
    },
    "location": {
      "id": 18,
      "name": "EU: Rotterdam"
    },
    "created_at": "2024-01-01 12:00:00",
    "updated_at": "2024-01-01 12:00:00",
    "client": {
      "id": 42,
      "username": "john.doe@i3d.net"
    },
    "contract_id": "MY-CONTRACT-ID",
    "name": "my-server-name.example.com",
    "status": "delivered",
    "status_message": "No server discovered.",
    "os": {
      "id": 9,
      "slug": "debian-9",
      "name": "debian",
      "version": "9"
    },
    "ip_addresses": [
      {
        "ip_address": "127.0.0.1"
      }
    ],
    "tags": [
      "env:prod"
    ],
    "delivered_at": "2024-01-01 12:00:00",
    "released_at": "2024-01-01 12:00:00",
    "request_id": 1234,
    "client_server_request": {}
  }
}

Get a specific tag for a specific client

get

Retrieve a speific tag for a specific client.

Authorizations

X-API-KeystringRequired

Path parameters

clientIdintegerRequired

ID of the client

Example: 42

tagstringRequired

The tag to list

Example: my_tagPattern: ^[A-Za-z0-9_:-]{1,64}$

Responses

200

Successful operation

application/json

401

Unauthenticated

404

Client not found

get/api/v1/client/{clientId}/tag/{tag}

GET /api/v1/client/{clientId}/tag/{tag} HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "tag": {
    "id": 1,
    "client_id": 1,
    "tag": "my_tag",
    "resources": {
      "count": 1,
      "flex_metal_servers": {
        "count": 1
      }
    },
    "created_at": "2024-01-01 12:00:00",
    "updated_at": "2024-01-01 12:00:00"
  }
}

Delete a tag for a specific client

delete

Delete a tag for a specific client.

Authorizations

X-API-KeystringRequired

Path parameters

clientIdintegerRequired

ID of the client

Example: 42

tagstringRequired

The tag to delete

Example: my_tagPattern: ^[A-Za-z0-9_:-]{1,64}$

Responses

204

Successful operation

No content

401

Unauthenticated

404

Client or Tag not found

delete/api/v1/client/{clientId}/tag/{tag}

DELETE /api/v1/client/{clientId}/tag/{tag} HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Rename a tag for a specific client

patch

Rename a tag for a specific client.

Authorizations

X-API-KeystringRequired

Path parameters

clientIdintegerRequired

ID of the client

Example: 42

tagstringRequired

The tag to rename

Example: my_tagPattern: ^[A-Za-z0-9_:-]{1,64}$

Body

tagstringOptionalExample: my_tagPattern: ^[A-Za-z0-9_:-]{1,64}$

Responses

200

Successful operation

application/json

401

Unauthenticated

404

Client or Tag not found

409

Target tag name already exists

patch/api/v1/client/{clientId}/tag/{tag}

PATCH /api/v1/client/{clientId}/tag/{tag} HTTP/1.1
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "tag": "my_tag"
}

{
  "tag": {
    "id": 1,
    "client_id": 1,
    "tag": "my_tag",
    "resources": {
      "count": 1,
      "flex_metal_servers": {
        "count": 1
      }
    },
    "created_at": "2024-01-01 12:00:00",
    "updated_at": "2024-01-01 12:00:00"
  }
}

List tags for a specific client

get

Retrieve a list of tags for a specific client with pagination.

Authorizations

X-API-KeystringRequired

Path parameters

clientIdintegerRequired

ID of the client

Example: 42

Responses

200

Successful operation

application/json

401

Unauthenticated

404

Client not found

get/api/v1/client/{clientId}/tag

GET /api/v1/client/{clientId}/tag HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "tags": [
    {
      "id": 1,
      "client_id": 1,
      "tag": "my_tag",
      "resources": {
        "count": 1,
        "flex_metal_servers": {
          "count": 1
        }
      },
      "created_at": "2024-01-01 12:00:00",
      "updated_at": "2024-01-01 12:00:00"
    }
  ],
  "paginator": {
    "from": "1",
    "to": "10",
    "total": "20",
    "current_page": "1",
    "last_page": "1",
    "first_page_url": "http://localhost:8100/api/v1/servers/1?page=1",
    "prev_page_url": null,
    "next_page_url": "http://localhost:8100/api/v1/orders/1?page=2",
    "last_page_url": "http://localhost:8100/api/v1/orders/1?page=3",
    "path": "http://localhost:8100/api/v1/orders/1",
    "per_page": "10"
  }
}

Create a tag for a specific client

post

Create a tag for a specific client.

Authorizations

X-API-KeystringRequired

Path parameters

clientIdintegerRequired

ID of the client

Example: 42

Body

tagstringOptionalExample: my_tagPattern: ^[A-Za-z0-9_:-]{1,64}$

Responses

200

Successful operation

application/json

401

Unauthenticated

409

Tag already exists for client

post/api/v1/client/{clientId}/tag

POST /api/v1/client/{clientId}/tag HTTP/1.1
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "tag": "my_tag"
}

{
  "tag": {
    "id": 1,
    "client_id": 1,
    "tag": "my_tag",
    "resources": {
      "count": 1,
      "flex_metal_servers": {
        "count": 1
      }
    },
    "created_at": "2024-01-01 12:00:00",
    "updated_at": "2024-01-01 12:00:00"
  }
}

Usage for 1 client endpoint

get

Usage for 1 client endpoint

Authorizations

X-API-KeystringRequired

Path parameters

clientIdintegerRequired

ID of the client

Query parameters

deliveredAtstring · datetimeOptionalExample: 2030-01-02 22:55:00

releasedAtstring · datetimeOptionalExample: 2030-01-15 22:55:00

limitintegerOptionalDefault: 15

pageintegerOptionalDefault: 1

Responses

200

Successful operation

application/json

400

Bad Request

401

Unauthenticated

422

Unprocessable Content

get/api/v1/client/{clientId}/usage

GET /api/v1/client/{clientId}/usage HTTP/1.1
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "servers": [
    {
      "serverId": 1,
      "locationId": 1,
      "instanceType": "text",
      "deliveredAt": "2024-01-01 12:00:00",
      "releasedAt": "2024-01-01 12:00:00",
      "bandwidth": {
        "startDate": "2024-01-01 12:00:00",
        "endDate": "2024-01-01 12:00:00",
        "bandwidthIn": 23556,
        "bandwidthOut": 23556
      },
      "contractId": "",
      "tags": [
        "text"
      ]
    }
  ],
  "paginator": {
    "from": "1",
    "to": "10",
    "total": "20",
    "current_page": "1",
    "last_page": "1",
    "first_page_url": "http://localhost:8100/api/v1/servers/1?page=1",
    "prev_page_url": null,
    "next_page_url": "http://localhost:8100/api/v1/orders/1?page=2",
    "last_page_url": "http://localhost:8100/api/v1/orders/1?page=3",
    "path": "http://localhost:8100/api/v1/orders/1",
    "per_page": "10"
  }
}

Last updated 1 year ago

Was this helpful?