v1

latestOpenAPI 3.0.32026-07-1419076.2 KB

Update an Existing Link

This endpoint updates an existing link owned by a client.

put/links/{id}

Path parameters

idinteger required

The ID used to identify the link.

Request body

namestring required

The name used to easily identify the link. Allowed values are between 2 and 255 characters.

statusstring required

The status of the link. Allowed values are active and inactive.

pathstring required

The path used to identify the the link to be redirected. Value after the root of the domain. Must be unique.

redirectstring required

The URL (with schema) to redirect visitors to when visiting the specified path.

domain_idinteger required

The Domain ID the link will be associated with.

tagsinteger[]

Array of Tag IDs that will be associated with the link.

Response

201

idinteger

namestring

pathstring

redirectstring

statusstring

health_statusstring

{"stackTrail":"paths:/links/{id}:put:responses:201:content:application/json:schema:properties:health_checked_at","oasType":"schema","type":"unknown"}

domain_idinteger

generated_urlstring

Example response

{
  "id": 1,
  "name": "Test Link",
  "path": "testing",
  "redirect": "https://seebot.run",
  "status": "active",
  "health_status": "unknown",
  "domain_id": 1000,
  "generated_url": "http://seebot.test/testing",
  "domain": {
    "id": 1000,
    "name": "seebot.test",
    "url": "seebot.test",
    "status": "deleted",
    "scope": "client"
  }
}