---
title: "POST /20200301/gateways"
method: POST
path: "/20200301/gateways"
---

# POST /20200301/gateways

`POST /20200301/gateways`

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html">Ingesting data using a gateway</a> in the <i>IoT SiteWise User Guide</i>.

## Request body

- object
  - `gatewayName` string, required — A unique, friendly name for the gateway.
  - `gatewayPlatform` object, required — Contains a gateway's platform information.
    - `greengrass` object — A gateway that runs on IoT Greengrass.
      - `groupArn` string, required — The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Greengrass group. For more information about how to find a group's ARN, see <a href="https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html">ListGroups</a> and <a href="https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html">GetGroup</a> in the <i>IoT Greengrass API Reference</i>.
    - `greengrassV2` object — A gateway that runs on IoT Greengrass V2.
      - `coreDeviceThingName` string, required — The name of the IoT thing for your IoT Greengrass V2 core device.
  - `tags` object — A list of key-value pairs that contain metadata for the gateway. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.

## Response `201`

Success

- CreateGatewayResponse
  - `gatewayId` string, required — The ID of the gateway device. You can use this ID when you call other IoT SiteWise APIs.
  - `gatewayArn` string, required — <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the gateway, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}</code> </p>

## Other responses

- `480` — InvalidRequestException
- `481` — ResourceAlreadyExistsException
- `482` — InternalFailureException
- `483` — ThrottlingException
- `484` — LimitExceededException

---

[API](https://skmtc.net/aws/apis/iotsitewise.md) · [All operations](https://skmtc.net/aws/apis/iotsitewise/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iotsitewise/versions/d13e5d3e0a6f/schema)