Create an allowed IP address range

POST

https://api.astronomer.io/v1/organizations/:organizationId/allowed-ip-address-ranges

POST

/v1/organizations/:organizationId/allowed-ip-address-ranges

$ curl -X POST https://api.astronomer.io/v1/organizations/organizationId/allowed-ip-address-ranges \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "ipAddressRange": "1.1.1.1/32"
> }'

1 {
2   "createdAt": "2022-11-22T04:37:12Z",
3   "id": "clm9sq6s0000008kz7uvl7yz7",
4   "ipAddressRange": "1.1.1.1/32",
5   "organizationId": "clyt27999000008me3yp39wcp",
6   "updatedAt": "2022-11-22T04:37:12Z",
7   "createdBy": {
8     "id": "clm8qv74h000008mlf08scq7k",
9     "apiTokenName": "my-token",
10     "avatarUrl": "https://avatar.url",
11     "fullName": "Jane Doe",
12     "subjectType": "USER",
13     "username": "user1@company.com"
14   },
15   "updatedBy": {
16     "id": "clm8qv74h000008mlf08scq7k",
17     "apiTokenName": "my-token",
18     "avatarUrl": "https://avatar.url",
19     "fullName": "Jane Doe",
20     "subjectType": "USER",
21     "username": "user1@company.com"
22   }
23 }

Create an allowed IP address range that constrains which IP addresses can be used to interact with your Astro Organization using APIs.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

The ID of the Organization where you want to create the allowed IP address range.

Request

This endpoint expects an object.

ipAddressRangestringRequired

The allowed IP address range in CIDR format.

Response

createdAtdatetime

The time when the allowed IP address range was created in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

idstring

The allowed IP address range's ID.

ipAddressRangestring

The allowed IP address range in CIDR format.

organizationIdstring

The allowed IP address range's Organization ID.

updatedAtdatetime

The time when the allowed IP address range was updated in UTC, formatted as YYYY-MM-DDTHH:MM:SSZ.

createdByobject

updatedByobject

Errors

400

Create Allowed IP Address Range Body Bad Request Error

401

Create Allowed IP Address Range Body Unauthorized Error

403

Create Allowed IP Address Range Body Forbidden Error

404

Create Allowed IP Address Range Body Not Found Error

500

Create Allowed IP Address Range Body Internal Server Error