Skip to content

Latest commit

 

History

History
422 lines (262 loc) · 13.3 KB

NetworkListsAPI.md

File metadata and controls

422 lines (262 loc) · 13.3 KB

NetworkListsAPI

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

Method HTTP request Description
CreateNetworkList Post /network_lists Create Network List.
DeleteNetworkLists Delete /network_lists Delete Network Lists.
DeleteSingleNetworkLists Delete /network_lists/{id} Delete Network Lists.
ListNetworkLists Get /network_lists List Network Lists.
ReadNetworkList Get /network_lists/{id} Read Network List.
UpdateNetworkList Put /network_lists/{id} Update Network List.

CreateNetworkList

NetworkListCreateResponse CreateNetworkList(ctx).Body(body).Execute()

Create Network List.

Example

package main

import (
	"context"
	"fmt"
	"os"

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

func main() {
	body := *fw.NewNetworkList() // NetworkList | The Network List object.

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

Path Parameters

Other Parameters

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

Name Type Description Notes
body NetworkList The Network List object.

Return type

NetworkListCreateResponse

Authorization

No authorization required

HTTP request headers

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

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

DeleteNetworkLists

DeleteNetworkLists(ctx).Body(body).Execute()

Delete Network Lists.

Example

package main

import (
	"context"
	"fmt"
	"os"

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

func main() {
	body := *fw.NewNetworkListsDeleteRequest() // NetworkListsDeleteRequest | 

	apiClient := fw.NewAPIClient()
	r, err := apiClient.NetworkListsAPI.DeleteNetworkLists(context.Background()).Body(body).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `NetworkListsAPI.DeleteNetworkLists``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

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

Name Type Description Notes
body NetworkListsDeleteRequest

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

DeleteSingleNetworkLists

DeleteSingleNetworkLists(ctx, id).Execute()

Delete Network Lists.

Example

package main

import (
	"context"
	"fmt"
	"os"

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

func main() {
	id := int32(56) // int32 | The Network List object identifier.

	apiClient := fw.NewAPIClient()
	r, err := apiClient.NetworkListsAPI.DeleteSingleNetworkLists(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `NetworkListsAPI.DeleteSingleNetworkLists``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

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]

ListNetworkLists

NetworkListMultiResponse ListNetworkLists(ctx).Filter(filter).Fields(fields).Offset(offset).Limit(limit).PageToken(pageToken).Execute()

List Network Lists.

Example

package main

import (
	"context"
	"fmt"
	"os"

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

func main() {

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

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a NetworkListsAPIListNetworkListsRequest 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.

Return type

NetworkListMultiResponse

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]

ReadNetworkList

NetworkListReadResponse ReadNetworkList(ctx, id).Fields(fields).Name(name).Execute()

Read Network List.

Example

package main

import (
	"context"
	"fmt"
	"os"

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

func main() {
	id := int32(56) // int32 | The Network List object identifier.

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes
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.
name string The name of the network list.

Return type

NetworkListReadResponse

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]

UpdateNetworkList

NetworkListUpdateResponse UpdateNetworkList(ctx, id).Body(body).Execute()

Update Network List.

Example

package main

import (
	"context"
	"fmt"
	"os"

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

func main() {
	id := int32(56) // int32 | The Network List object identifier.
	body := *fw.NewNetworkList() // NetworkList | The Network List object.

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes
body NetworkList The Network List object.

Return type

NetworkListUpdateResponse

Authorization

No authorization required

HTTP request headers

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

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