---
title: "Get the BYO-AWS CloudFormation setup link"
method: GET
path: "/v1/projectId/{projectId}/cloudformation-link"
tags: ["BYO AWS"]
---

# Get the BYO-AWS CloudFormation setup link

`GET /v1/projectId/{projectId}/cloudformation-link`

## Request

- Base URL: `https://api.bluefox.email`
- URL: `https://api.bluefox.email/v1/projectId/{projectId}/cloudformation-link`
- Auth: HTTP bearer

Generates (once, then reuses) the project's external ID and returns a CloudFormation quick-create link for the STS role bluefox.email needs to send through the project's own AWS account.

## Path parameters

- `projectId` string, required

## Response `200`

OK

- object
  - `status` integer
  - `result` CloudformationLink
    - `link` string: CloudFormation quick-create URL for the STS role bluefox.email needs to send through this project's own AWS account.

## Other responses

- `403`: Missing or invalid API key

---

[API](https://skmtc.dev/bluefox/apis/bluefox-email-public-api.md) · [All operations](https://skmtc.dev/bluefox/apis/bluefox-email-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bluefox/apis/bluefox-email-public-api/revisions/fa1a0a835c7f?raw)