---
title: "Get build remote access info"
method: GET
path: "/api/v3/builds/{build_id}/remote-access"
tags: ["Builds"]
---

# Get build remote access info

`GET /api/v3/builds/{build_id}/remote-access`

## Request

- Base URL: `https://codemagic.io`
- URL: `https://codemagic.io/api/v3/builds/{build_id}/remote-access`
- Auth: API key in header `x-auth-token`
- TypeScript: <https://skmtc.dev/codemagic/apis/codemagic-api/docs/api/v3/builds/:build_id/remote-access/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `build_id` string, required

## Response `200`

Request fulfilled, document follows

- union
  - RemoteAccessSchemaNoPagination
    - `data` RemoteAccessSchema, required
      - `ssh` RemoteAccessSshSchema, required
        - `script_url` string, required
      - `vnc` RemoteAccessVncSchema, required
        - `password` string, required
        - `port` integer, required
        - `host` string, required
        - `username` string, required
  - unknown

## Other responses

- `202`: Remote access is enabled but not yet available
- `400`: The request could not be validated
- `401`: Authentication is missing or invalid
- `403`: The caller lacks the required permission
- `404`: The requested resource does not exist
- `410`: Remote access is no longer available
- `429`: The rate limit has been exceeded

---

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