Update an allowed IP address range

POST

organizations

{organizationId}

allowed-ip-address-ranges

{allowedIpAddressRangeId}

Update an allowed IP address range

curl --request POST \
  --url https://api.astronomer.io/v1/organizations/{organizationId}/allowed-ip-address-ranges/{allowedIpAddressRangeId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Office VPN"
}
'

import requests

url = "https://api.astronomer.io/v1/organizations/{organizationId}/allowed-ip-address-ranges/{allowedIpAddressRangeId}"

payload = { "description": "Office VPN" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({description: 'Office VPN'})
};

fetch('https://api.astronomer.io/v1/organizations/{organizationId}/allowed-ip-address-ranges/{allowedIpAddressRangeId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.astronomer.io/v1/organizations/{organizationId}/allowed-ip-address-ranges/{allowedIpAddressRangeId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => 'Office VPN'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astronomer.io/v1/organizations/{organizationId}/allowed-ip-address-ranges/{allowedIpAddressRangeId}"

	payload := strings.NewReader("{\n  \"description\": \"Office VPN\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astronomer.io/v1/organizations/{organizationId}/allowed-ip-address-ranges/{allowedIpAddressRangeId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Office VPN\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/v1/organizations/{organizationId}/allowed-ip-address-ranges/{allowedIpAddressRangeId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Office VPN\"\n}"

response = http.request(request)
puts response.read_body

{
  "createdAt": "2022-11-22T04:37:12Z",
  "id": "clm9sq6s0000008kz7uvl7yz7",
  "ipAddressRange": "1.1.1.1/32",
  "organizationId": "clyt27999000008me3yp39wcp",
  "updatedAt": "2022-11-22T04:37:12Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "description": "Office VPN",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  }
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

organizationId

string

required

The ID of the Organization where the allowed IP address range exists.

allowedIpAddressRangeId

string

required

The ID of the allowed IP address range that you want to update.

Body

application/json

The request body for updating an allowed IP address range.

description

string

required

A label that describes the allowed IP address range. At most 500 characters. An empty string clears it. The range itself cannot change: delete it and create a new one instead.

Maximum string length: 500

Example:

"Office VPN"

Response

createdAt

string<date-time>

required

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

Example:

"2022-11-22T04:37:12Z"

string

required

The allowed IP address range's ID.

Example:

"clm9sq6s0000008kz7uvl7yz7"

ipAddressRange

string

required

The allowed IP address range in CIDR format.

Example:

"1.1.1.1/32"

organizationId

string

required

The allowed IP address range's Organization ID.

Example:

"clyt27999000008me3yp39wcp"

updatedAt

string<date-time>

required

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

Example:

"2022-11-22T04:37:12Z"

createdBy

object

Show child attributes

description

string

A label that describes the allowed IP address range.

Example:

"Office VPN"

updatedBy

object

Show child attributes

⌘I

Update an allowed IP address range

curl --request POST \
  --url https://api.astronomer.io/v1/organizations/{organizationId}/allowed-ip-address-ranges/{allowedIpAddressRangeId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Office VPN"
}
'

import requests

url = "https://api.astronomer.io/v1/organizations/{organizationId}/allowed-ip-address-ranges/{allowedIpAddressRangeId}"

payload = { "description": "Office VPN" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({description: 'Office VPN'})
};

fetch('https://api.astronomer.io/v1/organizations/{organizationId}/allowed-ip-address-ranges/{allowedIpAddressRangeId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.astronomer.io/v1/organizations/{organizationId}/allowed-ip-address-ranges/{allowedIpAddressRangeId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => 'Office VPN'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astronomer.io/v1/organizations/{organizationId}/allowed-ip-address-ranges/{allowedIpAddressRangeId}"

	payload := strings.NewReader("{\n  \"description\": \"Office VPN\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astronomer.io/v1/organizations/{organizationId}/allowed-ip-address-ranges/{allowedIpAddressRangeId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Office VPN\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astronomer.io/v1/organizations/{organizationId}/allowed-ip-address-ranges/{allowedIpAddressRangeId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Office VPN\"\n}"

response = http.request(request)
puts response.read_body

{
  "createdAt": "2022-11-22T04:37:12Z",
  "id": "clm9sq6s0000008kz7uvl7yz7",
  "ipAddressRange": "1.1.1.1/32",
  "organizationId": "clyt27999000008me3yp39wcp",
  "updatedAt": "2022-11-22T04:37:12Z",
  "createdBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  },
  "description": "Office VPN",
  "updatedBy": {
    "id": "clm8qv74h000008mlf08scq7k",
    "apiTokenName": "my-token",
    "avatarUrl": "https://avatar.url",
    "fullName": "Jane Doe",
    "subjectType": "USER",
    "username": "user1@company.com"
  }
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>",
  "requestId": "<string>",
  "statusCode": 500,
  "fieldErrors": [
    {
      "code": "<string>",
      "field": "<string>",
      "message": "<string>"
    }
  ]
}