Products

Get product by ID

get

Fetch a specific product by its ID, including linked IP address details

Path parameters
idstring · uuidRequired
Responses
200Success
application/json
get
/products/{id}
GET /v1/products/{id} 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"
    }
  ]
}

Update a product by ID

put

Update a product by ID

Path parameters
idstringRequired
Body
namestringRequired

The name of the product

descriptionstring | nullableOptional

Optional description of the product

expiryDatestringRequired

Expiry date in RFC3339 format

authenticatedIpsstring[] | nullableOptional

Authenticated IPs for the product

Responses
200Success
application/json
put
/products/{id}
PUT /v1/products/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "name": "text",
  "description": "text",
  "expiryDate": "text",
  "authenticatedIps": [
    "text"
  ]
}
{
  "name": "text",
  "description": "text",
  "expiryDate": "text",
  "authenticatedIps": [
    "text"
  ],
  "createdAt": "text"
}
patch
Path parameters
product_idstring · uuidRequired
Responses
patch
/products/{product_id}
PATCH /v1/products/{product_id} HTTP/1.1
Host: 
Accept: */*

No content
PreviousAPI DocumentationNext/