---
title: "Tests the proxy connection configured on the given profile and returns every individual test step together with an overall summary. The summary is 'success' when every step passes, 'partial_success' when the website could be reached through at least one of IPv4, IPv6 or DNS name and the IP location lookup also succeeded, otherwise 'failure'."
method: POST
path: "/profiles/{profileId}/test-proxy"
tags: ["Profile"]
---

# Tests the proxy connection configured on the given profile and returns every individual test step together with an overall summary. The summary is 'success' when every step passes, 'partial_success' when the website could be reached through at least one of IPv4, IPv6 or DNS name and the IP location lookup also succeeded, otherwise 'failure'.

`POST /profiles/{profileId}/test-proxy`

## Request

- Base URL: `http://localhost:5050`
- URL: `http://localhost:5050/profiles/{profileId}/test-proxy`
- Auth: none declared
- TypeScript: <https://skmtc.dev/kameleo-io/apis/kameleo-local-api/docs/profiles/:profileId/test-proxy/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `profileId` string, uuid, required

## Response `200`

OK.

- TestProxyResponse
  - `result` 'success' | 'partial_success' | 'failure', required: Summarizes the overall outcome of a proxy connectivity test. Possible values: 'success': Every test step passed. 'partial_success': The website could be reached through at least one of IPv4, IPv6 or DNS name, and the IP location lookup succeeded. 'failure': None of the connectivity checks succeeded.
  - `steps` ProxyTestStepResponse[], required: A list containing each individual test step performed while testing the proxy connection.
    - `step` 'ssh_connection' | 'direct_ping' | 'direct_https' | 'proxy_ipv4' | 'proxy_ipv6' | 'proxy_website' | 'proxy_location', required
    - `name` string, required: The name of the executed test case.
    - `successful` boolean, required: Whether the test was successful or not.
    - `comment` string, nullable: Any additional details about the test case, such as error messages.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Profile not found.
- `503`: The proxy connection failed.
- `default`: Error

## Changes

- **2026-09-28** `92359c8bd414`: 2 breaking
  - the response property `steps/items/comment` became nullable for the status `200`
  - the response property `steps/items/comment` became optional for the status `200`
- **2026-08-31** `576e5f3f4e3e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/kameleo-io/apis/kameleo-local-api/changes/profiles/:profileId/test-proxy/post.md)

---

[API](https://skmtc.dev/kameleo-io/apis/kameleo-local-api.md) - [All operations](https://skmtc.dev/kameleo-io/apis/kameleo-local-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kameleo-io/apis/kameleo-local-api/revisions/d3225562612a?raw)