Skip to content

Beta: these docs are still being updated. The next full update is on 18 November at 8 PM UTC. Docs in beta. Full update 18 Nov, 8 PM UTC.

Hoody.com

Use these endpoints to inspect, configure, start, stop, and remove a computer’s network proxy or blocking configuration. These endpoints use the Hoody control plane and require a Hoody account token.

Returns the current network configuration and status for a computer.

NameInTypeRequiredDescription
idpathstringYesUnique identifier of the computer to retrieve network configuration for

This endpoint does not accept a request body.

Terminal window
curl --request GET \
--url 'https://api.hoody.com/api/v1/computers/{id}/network' \
--header "Authorization: Bearer $HOODY_TOKEN" \
--header "Accept: application/json"

200 response fields

FieldTypeDescription
statusCodenumberHTTP status code.
messagestringResult message.
dataobjectNetwork configuration and status. When configured is false, only computer_id and configured are returned.
data.computer_idstringUnique identifier of the computer.
data.configuredbooleanWhether network configuration exists.
data.typestringNetwork configuration type. Allowed values are socks5, http, https, and block.
data.proxystringProxy server URL.
data.credentials_configuredbooleanWhether proxy credentials are stored. This field is present for owners, administrators, and collaborators with edit access.
data.countrystringDescriptive country label stored with the configuration. It does not select or change the proxy location.
data.citystringDescriptive city label stored with the configuration. It does not select or change the proxy location.
data.regionstringDescriptive region label stored with the configuration. It does not select or change the proxy location.
data.commentstringComment describing the network configuration.
data.dns_serversarrayCustom DNS server addresses.
data.statusstringNetwork status. Allowed values are configured, running, stopped, and error.
data.configured_atstringDate and time when the configuration was created.
data.last_status_checkstringDate and time of the latest status check.
data.remote_statusobject or nullLive network status on the computer. This value is null when the status could not be read.
data.remote_status.is_runningbooleanWhether the remote network service is running.
data.remote_status.last_checkstringDate and time of the latest remote status check.

Error response fields for 400, 401, 403, 404, 429, and 500

FieldTypeDescription
statusCodenumberHTTP status code.
errorstringError type.
messagestringError message.

422 response fields

FieldTypeDescription
statusCodenumberRequired. HTTP status code.
errorstringRequired. Error type.
messagestringRequired. Error message.
dataany JSON valueThe failing checks, when there are any.

Media type: application/json

The current network configuration and status were retrieved.

{
"statusCode": 200,
"message": "Network configuration retrieved successfully",
"data": {
"computer_id": "507f1f77bcf86cd799439012",
"configured": true,
"type": "socks5",
"proxy": "socks5://proxy.example.com:1080",
"credentials_configured": true,
"country": "US",
"city": "New York",
"region": "North America",
"comment": "Production proxy configuration",
"dns_servers": [
"1.1.1.1",
"8.8.8.8"
],
"status": "running",
"configured_at": "2025-01-15T10:00:00.000Z",
"last_status_check": "2025-01-15T20:00:00.000Z",
"remote_status": {
"is_running": true,
"last_check": "2025-01-15T20:00:00.000Z"
}
}
}

Configures or updates the network proxy or blocking settings for a computer. Normally, the computer must be running or paused to update its network configuration. Configuration may also be allowed when the computer cannot reach a startable state.

PATCH is also accepted for this endpoint with identical behavior.

NameInTypeRequiredDescription
idpathstringYesUnique identifier of the computer to configure network for

The request body is required.

NameTypeRequiredDescription
typestringYesNetwork configuration type. Allowed values are socks5, http, https, and block.
proxystringNoProxy server URL. Required for non-block types and omitted for block. For example, socks5://proxy.example.com:1080.
countrystringNoOptional descriptive label, at most 100 characters. It is stored and returned as given and does not select or change the proxy location.
citystringNoOptional descriptive label, at most 100 characters. It is stored and returned as given and does not select or change the proxy location.
regionstringNoOptional descriptive label, at most 100 characters. It is stored and returned as given and does not select or change the proxy location.
commentstringNoComment describing the network configuration. Maximum length: 1000 characters.
dns_serversarrayNoDNS server addresses. Maximum: 4. Custom DNS servers are not applied. Any submitted array of at most four entries is accepted and stored as ["1.1.1.1", "8.8.8.8"].
{
"type": "socks5",
"proxy": "socks5://proxy.example.com:1080",
"country": "US",
"city": "New York",
"region": "North America",
"comment": "Production proxy for US traffic",
"dns_servers": [
"1.1.1.1",
"8.8.8.8"
]
}
Terminal window
curl --request PUT \
--url 'https://api.hoody.com/api/v1/computers/{id}/network' \
--header "Authorization: Bearer $HOODY_TOKEN" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data '{
"type": "socks5",
"proxy": "socks5://proxy.example.com:1080",
"country": "US",
"city": "New York",
"region": "North America",
"comment": "Production proxy for US traffic",
"dns_servers": [
"1.1.1.1",
"8.8.8.8"
]
}'

200 response fields

FieldTypeDescription
statusCodenumberHTTP status code.
messagestringResult message.
dataobjectUpdated network configuration.
data.computer_idstringUnique identifier of the computer.
data.typestringNetwork configuration type. Allowed values are socks5, http, https, and block.
data.proxystringProxy server URL.
data.credentials_configuredbooleanWhether proxy credentials are stored.
data.countrystringDescriptive country label stored with the configuration. It does not select or change the proxy location.
data.citystringDescriptive city label stored with the configuration. It does not select or change the proxy location.
data.regionstringDescriptive region label stored with the configuration. It does not select or change the proxy location.
data.commentstringComment describing the network configuration.
data.dns_serversarrayCustom DNS server addresses.
data.statusstringNetwork status. Allowed values are configured, running, stopped, and error.
data.configured_atstringDate and time when the configuration was created.

Error response fields for 400, 401, 403, 404, 429, and 500

FieldTypeDescription
statusCodenumberHTTP status code.
errorstringError type.
messagestringError message.

409 and 422 response fields

FieldTypeDescription
statusCodenumberRequired. HTTP status code.
errorstringRequired. Error type.
messagestringRequired. Error message.
dataany JSON valueAdditional error details or failing checks, when present.

Media type: application/json

The network configuration was updated.

{
"statusCode": 200,
"message": "Network configuration updated successfully",
"data": {
"computer_id": "507f1f77bcf86cd799439012",
"type": "socks5",
"proxy": "socks5://proxy.example.com:1080",
"credentials_configured": true,
"country": "US",
"city": "New York",
"region": "North America",
"comment": "Production proxy for US traffic",
"dns_servers": [
"1.1.1.1",
"8.8.8.8"
],
"status": "configured",
"configured_at": "2025-01-15T21:00:00.000Z"
}
}

Starts the network proxy or blocking service for a computer.

NameInTypeRequiredDescription
idpathstringYesUnique identifier of the computer to start network for

This endpoint does not accept a request body.

Terminal window
curl --request POST \
--url 'https://api.hoody.com/api/v1/computers/{id}/network/start' \
--header "Authorization: Bearer $HOODY_TOKEN" \
--header "Accept: application/json"

200 response fields

FieldTypeDescription
statusCodenumberHTTP status code.
messagestringResult message.
dataobjectNetwork service status.
data.computer_idstringUnique identifier of the computer.
data.statusstringNetwork status. Allowed values are configured, running, stopped, and error.
data.is_runningbooleanWhether the network service is running.
data.last_checkstringDate and time of the latest status check.

Error response fields for 400, 401, 403, 404, 429, and 500

FieldTypeDescription
statusCodenumberHTTP status code.
errorstringError type.
messagestringError message.

409 and 422 response fields

FieldTypeDescription
statusCodenumberRequired. HTTP status code.
errorstringRequired. Error type.
messagestringRequired. Error message.
dataany JSON valueAdditional error details or failing checks, when present.

Media type: application/json

The network was started.

{
"statusCode": 200,
"message": "Network started successfully",
"data": {
"computer_id": "507f1f77bcf86cd799439012",
"status": "running",
"is_running": true,
"last_check": "2025-01-15T21:05:00.000Z"
}
}

Stops the network proxy or blocking service for a computer. The configuration is preserved and can be started again with the start endpoint.

NameInTypeRequiredDescription
idpathstringYesUnique identifier of the computer to stop network for

This endpoint does not accept a request body.

Terminal window
curl --request POST \
--url 'https://api.hoody.com/api/v1/computers/{id}/network/stop' \
--header "Authorization: Bearer $HOODY_TOKEN" \
--header "Accept: application/json"

200 response fields

FieldTypeDescription
statusCodenumberHTTP status code.
messagestringResult message.
dataobjectNetwork service status.
data.computer_idstringUnique identifier of the computer.
data.statusstringNetwork status. Allowed values are configured, running, stopped, and error.
data.is_runningbooleanWhether the network service is running.
data.last_checkstringDate and time of the latest status check.

Error response fields for 400, 401, 403, 404, 429, and 500

FieldTypeDescription
statusCodenumberHTTP status code.
errorstringError type.
messagestringError message.

409 and 422 response fields

FieldTypeDescription
statusCodenumberRequired. HTTP status code.
errorstringRequired. Error type.
messagestringRequired. Error message.
dataany JSON valueAdditional error details or failing checks, when present.

Media type: application/json

The network was stopped.

{
"statusCode": 200,
"message": "Network stopped successfully",
"data": {
"computer_id": "507f1f77bcf86cd799439012",
"status": "stopped",
"is_running": false,
"last_check": "2025-01-15T21:10:00.000Z"
}
}

Removes the entire network proxy or blocking configuration for a computer. The computer falls back to direct network access once the configuration is cleared.

NameInTypeRequiredDescription
idpathstringYesUnique identifier of the computer to remove network configuration from

This endpoint does not accept a request body.

Terminal window
curl --request DELETE \
--url 'https://api.hoody.com/api/v1/computers/{id}/network' \
--header "Authorization: Bearer $HOODY_TOKEN" \
--header "Accept: application/json"

200 response fields

FieldTypeDescription
statusCodenumberHTTP status code.
messagestringResult message.

Error response fields for 400, 401, 403, 404, 429, and 500

FieldTypeDescription
statusCodenumberHTTP status code.
errorstringError type.
messagestringError message.

409 and 422 response fields

FieldTypeDescription
statusCodenumberRequired. HTTP status code.
errorstringRequired. Error type.
messagestringRequired. Error message.
dataany JSON valueAdditional error details or failing checks, when present.

Media type: application/json

The network configuration was removed.

{
"statusCode": 200,
"message": "Network configuration removed successfully"
}