IPAllowlistsApi.md

IPAllowlists

All URIs are relative to https://cockroachlabs.cloud

Method	HTTP request	Description
AddAllowlistEntry	Post /api/v1/clusters/{cluster_id}/networking/allowlist	Add a new CIDR address to the IP allowlist
AddAllowlistEntry2	Put /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}	Add a new CIDR address to the IP allowlist
DeleteAllowlistEntry	Delete /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}	Delete an IP allowlist entry
ListAllowlistEntries	Get /api/v1/clusters/{cluster_id}/networking/allowlist	Get the IP allowlist and propagation status for a cluster
UpdateAllowlistEntry	Patch /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}	Update an IP allowlist entry

AddAllowlistEntry

AllowlistEntry AddAllowlistEntry(ctx, clusterId).AllowlistEntry(allowlistEntry).Execute()

Add a new CIDR address to the IP allowlist

Can be used by the following roles assigned at the organization, folder or cluster scope:

• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    clusterId := "clusterId_example" // string | 
    allowlistEntry := *openapiclient.NewAllowlistEntry("CidrIp_example", int32(123), false, false) // AllowlistEntry | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewClient(configuration)
    resp, r, err := api_client.IPAllowlistsApi.AddAllowlistEntry(context.Background(), clusterId).AllowlistEntry(allowlistEntry).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IPAllowlistsApi.AddAllowlistEntry``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AddAllowlistEntry`: AllowlistEntry
    fmt.Fprintf(os.Stdout, "Response from `IPAllowlistsApi.AddAllowlistEntry`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
clusterId	string

Other Parameters

Name	Type	Description	Notes

allowlistEntry | AllowlistEntry | |

Return type

AllowlistEntry

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to README]

AddAllowlistEntry2

AllowlistEntry AddAllowlistEntry2(ctx, clusterId, cidrIp, cidrMask).AllowlistEntry1(allowlistEntry1).Execute()

Add a new CIDR address to the IP allowlist

Can be used by the following roles assigned at the organization, folder or cluster scope:

• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    clusterId := "clusterId_example" // string | 
    cidrIp := "cidrIp_example" // string | 
    cidrMask := int32(56) // int32 | 
    allowlistEntry1 := *openapiclient.NewAllowlistEntry1(false, false) // AllowlistEntry1 | AllowlistEntry

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewClient(configuration)
    resp, r, err := api_client.IPAllowlistsApi.AddAllowlistEntry2(context.Background(), clusterId, cidrIp, cidrMask).AllowlistEntry1(allowlistEntry1).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IPAllowlistsApi.AddAllowlistEntry2``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AddAllowlistEntry2`: AllowlistEntry
    fmt.Fprintf(os.Stdout, "Response from `IPAllowlistsApi.AddAllowlistEntry2`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
clusterId	string
cidrIp	string
cidrMask	int32

Other Parameters

Name	Type	Description	Notes

allowlistEntry1 | AllowlistEntry1 | AllowlistEntry |

Return type

AllowlistEntry

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to README]

DeleteAllowlistEntry

AllowlistEntry DeleteAllowlistEntry(ctx, clusterId, cidrIp, cidrMask).Execute()

Delete an IP allowlist entry

Can be used by the following roles assigned at the organization, folder or cluster scope:

• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    clusterId := "clusterId_example" // string | 
    cidrIp := "cidrIp_example" // string | 
    cidrMask := int32(56) // int32 | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewClient(configuration)
    resp, r, err := api_client.IPAllowlistsApi.DeleteAllowlistEntry(context.Background(), clusterId, cidrIp, cidrMask).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IPAllowlistsApi.DeleteAllowlistEntry``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteAllowlistEntry`: AllowlistEntry
    fmt.Fprintf(os.Stdout, "Response from `IPAllowlistsApi.DeleteAllowlistEntry`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
clusterId	string
cidrIp	string
cidrMask	int32

Other Parameters

Name	Type	Description	Notes

Return type

AllowlistEntry

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to README]

ListAllowlistEntries

ListAllowlistEntriesResponse ListAllowlistEntries(ctx, clusterId).PaginationPage(paginationPage).PaginationLimit(paginationLimit).PaginationAsOfTime(paginationAsOfTime).PaginationSortOrder(paginationSortOrder).Execute()

Get the IP allowlist and propagation status for a cluster

Sort order: CIDR address

Can be used by the following roles assigned at the organization, folder or cluster scope:

• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER
• CLUSTER_DEVELOPER

Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    clusterId := "clusterId_example" // string | 
    paginationPage := "paginationPage_example" // string |  (optional)
    paginationLimit := int32(56) // int32 |  (optional)
    paginationAsOfTime := time.Now() // time.Time |  (optional)
    paginationSortOrder := "paginationSortOrder_example" // string |  - ASC: Sort in ascending order. This is the default unless otherwise specified.  - DESC: Sort in descending order. (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewClient(configuration)
    resp, r, err := api_client.IPAllowlistsApi.ListAllowlistEntries(context.Background(), clusterId).PaginationPage(paginationPage).PaginationLimit(paginationLimit).PaginationAsOfTime(paginationAsOfTime).PaginationSortOrder(paginationSortOrder).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IPAllowlistsApi.ListAllowlistEntries``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListAllowlistEntries`: ListAllowlistEntriesResponse
    fmt.Fprintf(os.Stdout, "Response from `IPAllowlistsApi.ListAllowlistEntries`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
clusterId	string

Other Parameters

Optional parameters can be passed through a pointer to the ListAllowlistEntriesOptions struct.

Name	Type	Description	Notes

paginationPage | string | | paginationLimit | int32 | | paginationAsOfTime | time.Time | | paginationSortOrder | string | - ASC: Sort in ascending order. This is the default unless otherwise specified. - DESC: Sort in descending order. |

Return type

ListAllowlistEntriesResponse

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to README]

UpdateAllowlistEntry

AllowlistEntry UpdateAllowlistEntry(ctx, clusterId, cidrIp, cidrMask).AllowlistEntry1(allowlistEntry1).Execute()

Update an IP allowlist entry

Can be used by the following roles assigned at the organization, folder or cluster scope:

• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    clusterId := "clusterId_example" // string | 
    cidrIp := "cidrIp_example" // string | 
    cidrMask := int32(56) // int32 | 
    allowlistEntry1 := *openapiclient.NewAllowlistEntry1(false, false) // AllowlistEntry1 | AllowlistEntry

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewClient(configuration)
    resp, r, err := api_client.IPAllowlistsApi.UpdateAllowlistEntry(context.Background(), clusterId, cidrIp, cidrMask).AllowlistEntry1(allowlistEntry1).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IPAllowlistsApi.UpdateAllowlistEntry``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateAllowlistEntry`: AllowlistEntry
    fmt.Fprintf(os.Stdout, "Response from `IPAllowlistsApi.UpdateAllowlistEntry`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
clusterId	string
cidrIp	string
cidrMask	int32

Other Parameters

Name	Type	Description	Notes

allowlistEntry1 | AllowlistEntry1 | AllowlistEntry |

Return type

AllowlistEntry

Authorization

Bearer

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to README]