IAM API Reference Allowed IP Address Range

List allowed IP address ranges

GET

List allowed IP address ranges.

Path parameters

organizationIdstringRequired

The ID of the Organization that you want to retrieve the list of IP addresses for.

Query parameters

offsetintegerOptional

The number of results to skip before returning values.

limitintegerOptional

The maximum number of results to return.

sortsenumOptional

A list of field names to sort by, and whether to show results as ascending or descending. Formatted as <fieldName>:asc or <fieldName>:desc.

Response

This endpoint returns an object.

allowedIpAddressRangeslist of objects

limitinteger

The maximum number of allowed IP address ranges in one page.

offsetinteger

The offset of the current page of allowed IP address ranges.

totalCountinteger

The total number of allowed IP address ranges.

GET

1 curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/allowed-ip-address-ranges \
2      -H "Authorization: Bearer <token>"

200Retrieved

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

Built with

1	curl https://api.astronomer.io/iam/v1beta1/organizations/organizationId/allowed-ip-address-ranges \
2	-H "Authorization: Bearer <token>"

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