Skip to content

Latest commit

 

History

History
499 lines (313 loc) · 16.5 KB

InternalDomainListsAPI.md

File metadata and controls

499 lines (313 loc) · 16.5 KB

InternalDomainListsAPI

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

Method HTTP request Description
CreateInternalDomains Post /internal_domain_lists Create Internal Domains.
DeleteInternalDomains Delete /internal_domain_lists Delete Internal Domains.
DeleteSingleInternalDomains Delete /internal_domain_lists/{id} Delete Internal Domains.
InternalDomainsItemsPartialUpdate Patch /internal_domain_lists/{id}/items Patch Internal Domains.
ListInternalDomains Get /internal_domain_lists List Internal Domains.
ReadInternalDomains Get /internal_domain_lists/{id} Read Internal Domains.
UpdateInternalDomains Put /internal_domain_lists/{id} Update Internal Domains.

CreateInternalDomains

InternalDomainsCreateResponse CreateInternalDomains(ctx).Body(body).Execute()

Create Internal Domains.

Example

package main

import (
	"context"
	"fmt"
	"os"

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

func main() {
	body := *fw.NewInternalDomains() // InternalDomains | The Internal Domains object.

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

Path Parameters

Other Parameters

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

Name Type Description Notes
body InternalDomains The Internal Domains object.

Return type

InternalDomainsCreateResponse

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]

DeleteInternalDomains

DeleteInternalDomains(ctx).Body(body).Execute()

Delete Internal Domains.

Example

package main

import (
	"context"
	"fmt"
	"os"

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

func main() {
	body := *fw.NewInternalDomainsDeleteRequest() // InternalDomainsDeleteRequest | 

	apiClient := fw.NewAPIClient()
	r, err := apiClient.InternalDomainListsAPI.DeleteInternalDomains(context.Background()).Body(body).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `InternalDomainListsAPI.DeleteInternalDomains``: %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 InternalDomainListsAPIDeleteInternalDomainsRequest struct via the builder pattern

Name Type Description Notes
body InternalDomainsDeleteRequest

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]

DeleteSingleInternalDomains

DeleteSingleInternalDomains(ctx, id).Execute()

Delete Internal Domains.

Example

package main

import (
	"context"
	"fmt"
	"os"

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

func main() {
	id := int32(56) // int32 | The Internal Domains object identifiers.

	apiClient := fw.NewAPIClient()
	r, err := apiClient.InternalDomainListsAPI.DeleteSingleInternalDomains(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `InternalDomainListsAPI.DeleteSingleInternalDomains``: %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 Internal Domains object identifiers.

Other Parameters

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

InternalDomainsItemsPartialUpdate

map[string]interface{} InternalDomainsItemsPartialUpdate(ctx, id).Body(body).Execute()

Patch Internal Domains.

Example

package main

import (
	"context"
	"fmt"
	"os"

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

func main() {
	id := int32(56) // int32 | The Internal Domain List object identifier.
	body := *fw.NewInternalDomainsItems() // InternalDomainsItems | The Internal Domains Items Patch object.

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes
body InternalDomainsItems The Internal Domains Items Patch object.

Return type

map[string]interface{}

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]

ListInternalDomains

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

List Internal Domains.

Example

package main

import (
	"context"
	"fmt"
	"os"

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

func main() {

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

Path Parameters

Other Parameters

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

InternalDomainsMultiResponse

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]

ReadInternalDomains

InternalDomainsReadResponse ReadInternalDomains(ctx, id).Fields(fields).Name(name).Offset(offset).Limit(limit).PageToken(pageToken).Execute()

Read Internal Domains.

Example

package main

import (
	"context"
	"fmt"
	"os"

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

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

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

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a InternalDomainListsAPIReadInternalDomainsRequest 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 InternalDomains object. Used if id==0.
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

InternalDomainsReadResponse

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]

UpdateInternalDomains

InternalDomainsUpdateResponse UpdateInternalDomains(ctx, id).Body(body).Execute()

Update Internal Domains.

Example

package main

import (
	"context"
	"fmt"
	"os"

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

func main() {
	id := int32(56) // int32 | The Internal Domain object identifier.
	body := *fw.NewInternalDomains() // InternalDomains | The Internal Domains object.

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes
body InternalDomains The Internal Domains object.

Return type

InternalDomainsUpdateResponse

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]