/

Get all products with linked IPs

get

Get all products and their linked IP address details

Query parameters
userstring | nullableOptional
Responses
200Success
application/json
get
/products/
GET /v1/products/ HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "createdAt": "text",
    "expiryDate": "text",
    "userId": "text",
    "authenticatedIps": [
      "text"
    ],
    "linkedIps": [
      {
        "ipAddressId": "123e4567-e89b-12d3-a456-426614174000",
        "username": "text",
        "password": "text"
      }
    ]
  }
]

Create a new product and link it to a user and IPs

post

Create a new product and assign it to a user. IPs are fetched linearly from subnets tied to the server.

Body
namestringRequired

Username to be used for IP Auth

descriptionstringRequired
ip_countinteger · int64Required
user_idstringRequired
server_idstring · uuidRequired
expiry_datestringRequired
authenticated_ipsstring[] | nullableOptional
Responses
200Success
application/json
post
/products/
POST /v1/products/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "name": "text",
  "description": "text",
  "ip_count": 1,
  "user_id": "text",
  "server_id": "123e4567-e89b-12d3-a456-426614174000",
  "expiry_date": "text",
  "authenticated_ips": [
    "text"
  ]
}
{
  "product": {
    "id": "text",
    "name": "text",
    "description": "text",
    "createdAt": "text",
    "expiryDate": "text",
    "userId": "text",
    "authenticatedIps": [
      "text"
    ]
  },
  "ip_address_details": [
    {
      "ip_address": "text",
      "username": "text",
      "password": "text",
      "subnet_id": "text"
    }
  ]
}
PreviousProductsNextServers