Skip to content

Port management

All operations use the account-scoped port identifier as {id}.

POST /ports/{id}/tags replaces the port tag list. The public contract allows up to 30 tags and up to 50 characters per tag.

{
"tags": ["production", "crawler-eu"]
}

POST /ports/{id}/credentials replaces credential configuration. The model contains:

  • ip: an array of allowed source IP addresses;
  • password: an array of objects with login and password.
{
"ip": ["203.0.113.10"],
"password": [
{
"login": "integration",
"password": "use-a-generated-secret"
}
]
}

Keep passwords in a secret manager and avoid returning them from your own APIs.

EndpointBodyPurpose
POST /ports/{id}/signature{ "signature": "Linux" }Apply a current signature from GET /signatures
POST /ports/{id}/autorenew{ "autoRenew": true }Enable or disable plan renewal
POST /ports/{id}/autoreset{ "autoResetInterval": 600 }Set reset interval in seconds; 0 disables it

GET /ports/{id}/log returns recent events. POST /ports/{id}/log accepts from, to, page, and pageSize to filter history. Store timestamps in UTC and page until complete.

GET /ports/{id}/vpn downloads the port VPN configuration archive. A POST compatibility route is also present. Treat the archive as a secret because it can contain connection material, and inspect the response as binary rather than JSON.

GET /tokens/{token} resolves a port reset token to its port model. This route still requires the account bearer token; the path token is not a replacement for API authentication.