PopRegionsAPI.md

PopRegionsAPI

All URIs are relative to https://csp.infoblox.com/api/atcfw/v1

Method	HTTP request	Description
ListPoPRegions	Get /pop_regions	List PoP Regions.
ReadPoPRegion	Get /pop_regions/{id}	Read PoP Region.

ListPoPRegions

ListPoPRegionsResponse ListPoPRegions(ctx).Filter(filter).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).Tfilter(tfilter).TorderBy(torderBy).Execute()

List PoP Regions.

Example

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/infobloxopen/bloxone-go-client/fw"
)

func main() {

	apiClient := fw.NewAPIClient()
	resp, r, err := apiClient.PopRegionsAPI.ListPoPRegions(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PopRegionsAPI.ListPoPRegions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListPoPRegions`: ListPoPRegionsResponse
	fmt.Fprintf(os.Stdout, "Response from `PopRegionsAPI.ListPoPRegions`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a PopRegionsAPIListPoPRegionsRequest struct via the builder pattern

Name	Type	Description	Notes
filter	string	A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. You can filter by following fields:	Name
fields	string	A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names.
offset	int32	The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'.
limit	int32	The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value.
pageToken	string	The service-defined string used to identify a page of resources. A null value indicates the first page.
tfilter	string	Filtering by tags.
torderBy	string	Sorting by tags.

Return type

ListPoPRegionsResponse

Authorization

No authorization required

HTTP request headers

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

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

ReadPoPRegion

ReadPoPRegionResponse ReadPoPRegion(ctx, id).Execute()

Read PoP Region.

Example

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/infobloxopen/bloxone-go-client/fw"
)

func main() {
	id := int32(56) // int32 | The PoP region object identifier

	apiClient := fw.NewAPIClient()
	resp, r, err := apiClient.PopRegionsAPI.ReadPoPRegion(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PopRegionsAPI.ReadPoPRegion``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ReadPoPRegion`: ReadPoPRegionResponse
	fmt.Fprintf(os.Stdout, "Response from `PopRegionsAPI.ReadPoPRegion`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	int32	The PoP region object identifier

Other Parameters

Other parameters are passed through a pointer to a PopRegionsAPIReadPoPRegionRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ReadPoPRegionResponse

Authorization

No authorization required

HTTP request headers

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

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