mongodbatlas

package
v0.0.0-...-1debad0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 11, 2019 License: GPL-3.0 Imports: 5 Imported by: 16

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIError 

type APIError struct {
	Detail    string `json:"detail"`
	Code      int    `json:"error"`
	ErrorCode string `json:"errorCode"`
	Reason    string `json:"reason"`
}

APIError represents a MongDB Atlas API Error response https://docs.atlas.mongodb.com/api/#errors

func (APIError) Error 

func (e APIError) Error() string

type AlertConfiguration 

type AlertConfiguration struct {
	ID              string          `json:"id,omitempty"`
	GroupID         string          `json:"groupId,omitempty"`
	EventTypeName   string          `json:"eventTypeName,omitempty"`
	Enabled         bool            `json:"enabled,omitempty"`
	Notifications   []Notification  `json:"notifications,omitempty"`
	MetricThreshold MetricThreshold `json:"metricThreshold,omitempty"`
	Matchers        []Matcher       `json:"matchers,omitempty"`
}

AlertConfiguration represents an AlertConfiguration in MongoDB.

func (AlertConfiguration) MarshalJSON 

func (r AlertConfiguration) MarshalJSON() ([]byte, error)

MarshalJSON is custom defined here because the API pukes if you specify an empty metricThreshold ("metricThreshold":{}) when it doesn't want one

type AlertConfigurationService 

type AlertConfigurationService struct {
	// contains filtered or unexported fields
}

AlertConfigurationService provides methods for accessing MongoDB Atlas Alert Configurations API endpoints.

func (*AlertConfigurationService) Create 

func (c *AlertConfigurationService) Create(gid string, alertConfigurationParams *AlertConfiguration) (*AlertConfiguration, *http.Response, error)

Create an alert configuration in the specified group. https://docs.atlas.mongodb.com/reference/api/alert-configurations-create-config/

func (*AlertConfigurationService) Delete 

func (c *AlertConfigurationService) Delete(gid string, id string) (*http.Response, error)

Delete an alert configuration in the specified group. https://docs.atlas.mongodb.com/reference/api/alert-configurations-update-config/

func (*AlertConfigurationService) Get 

func (c *AlertConfigurationService) Get(gid string, id string) (*AlertConfiguration, *http.Response, error)

Get an alert configuration in the specified group. https://docs.atlas.mongodb.com/reference/api/alert-configurations-get-config/

func (*AlertConfigurationService) List 

func (c *AlertConfigurationService) List(gid string) ([]AlertConfiguration, *http.Response, error)

List all alert configurations for the specified group. https://docs.atlas.mongodb.com/reference/api/alert-configurations-get-all-configs/

func (*AlertConfigurationService) Update 

func (c *AlertConfigurationService) Update(gid string, id string, alertConfigurationParams *AlertConfiguration) (*AlertConfiguration, *http.Response, error)

Update an alert configuration in the specified group. https://docs.atlas.mongodb.com/reference/api/alert-configurations-update-config/

type AtlasRole 

type AtlasRole struct {
	OrgID    string `json:"orgId,omitempty"`
	GroupID  string `json:"groupId,omitempty"`
	RoleName string `json:"roleName,omitempty"`
}

AtlasRole represents the permission on either the organization or group level

type AtlasUser 

type AtlasUser struct {
	EmailAddress string      `json:"emailAddress,omitempty"`
	ID           string      `json:"id,omitempty"`
	Username     string      `json:"username,omitempty"`
	FirstName    string      `json:"firstName,omitempty"`
	LastName     string      `json:"lastName,omitempty"`
	Password     string      `json:"password,omitempty"`
	MobileNumber string      `json:"mobileNumber,omitempty"`
	Country      string      `json:"country,omitempty"`
	Roles        []AtlasRole `json:"roles,omitempty"`
	TeamIDs      []string    `json:"teamIds,omitempty"`
}

AtlasUser represents users in your MongoDB Atlas UI.

type AtlasUserService 

type AtlasUserService struct {
	// contains filtered or unexported fields
}

AtlasUserService provides methods for accessing MongoDB Atlas AtlasUsers API endpoints. https://docs.atlas.mongodb.com/reference/api/user/

func (*AtlasUserService) Create 

func (c *AtlasUserService) Create(atlasUserParams *AtlasUser) (*AtlasUser, *http.Response, error)

Create an atlasUser https://docs.atlas.mongodb.com/reference/api/user-create/

func (*AtlasUserService) Get 

func (c *AtlasUserService) Get(id string) (*AtlasUser, *http.Response, error)

Get an atlasUser by ID. https://docs.atlas.mongodb.com/reference/api/user-get-by-id/

func (*AtlasUserService) GetByName 

func (c *AtlasUserService) GetByName(name string) (*AtlasUser, *http.Response, error)

GetByName gets an atlasUser by Name. https://docs.atlas.mongodb.com/reference/api/user-get-one-by-name/

func (*AtlasUserService) Update 

func (c *AtlasUserService) Update(id string, atlasUserParams *AtlasUser) (*AtlasUser, *http.Response, error)

Update an atlasUser https://docs.atlas.mongodb.com/reference/api/user-update/

type AutoScaling 

type AutoScaling struct {
	DiskGBEnabled bool `json:"diskGBEnabled"`
}

AutoScaling has the information on whether disk auto-scaling is enabled.

type Client 

type Client struct {
	Root                *RootService
	Whitelist           *WhitelistService
	Projects            *ProjectService
	Clusters            *ClusterService
	Containers          *ContainerService
	Peers               *PeerService
	DatabaseUsers       *DatabaseUserService
	Organizations       *OrganizationService
	AlertConfigurations *AlertConfigurationService
	SnapshotSchedule    *SnapshotScheduleService
	AtlasUsers          *AtlasUserService
	PrivateIPMode       *PrivateIPModeService
	// contains filtered or unexported fields
}

Client is a MongoDB Atlas client for making MongoDB API requests.

func NewClient 

func NewClient(httpClient *http.Client) *Client

NewClient returns a new Client.

type Cluster 

type Cluster struct {
	ID                    string                     `json:"id,omitempty"`
	GroupID               string                     `json:"groupId,omitempty"`
	Name                  string                     `json:"name,omitempty"`
	MongoDBVersion        string                     `json:"mongoDBVersion,omitempty"`
	MongoDBMajorVersion   string                     `json:"mongoDBMajorVersion,omitempty"`
	MongoURI              string                     `json:"mongoURI,omitempty"`
	MongoURIUpdated       string                     `json:"mongoURIUpdated,omitempty"`
	MongoURIWithOptions   string                     `json:"mongoURIWithOptions,omitempty"`
	SrvAddress            string                     `json:"srvAddress,omitempty"`
	DiskSizeGB            float64                    `json:"diskSizeGB,omitempty"`
	BackupEnabled         bool                       `json:"backupEnabled"`
	ProviderBackupEnabled bool                       `json:"providerBackupEnabled"`
	StateName             string                     `json:"stateName,omitempty"`
	ReplicationFactor     int                        `json:"replicationFactor,omitempty"`
	ReplicationSpec       map[string]ReplicationSpec `json:"replicationSpec,omitempty"`
	NumShards             int                        `json:"numShards,omitempty"`
	Paused                bool                       `json:"paused"`
	AutoScaling           AutoScaling                `json:"autoScaling,omitempty"`
	ProviderSettings      ProviderSettings           `json:"providerSettings,omitempty"`
}

Cluster represents a Cluster configuration in MongoDB.

type ClusterService 

type ClusterService struct {
	// contains filtered or unexported fields
}

ClusterService provides methods for accessing MongoDB Atlas Clusters API endpoints.

func (*ClusterService) Create 

func (c *ClusterService) Create(gid string, clusterParams *Cluster) (*Cluster, *http.Response, error)

Create a cluster in the specified group. https://docs.atlas.mongodb.com/reference/api/clusters-create-one/

func (*ClusterService) Delete 

func (c *ClusterService) Delete(gid string, name string) (*http.Response, error)

Delete a cluster in the specified group. https://docs.atlas.mongodb.com/reference/api/clusters-delete-one/

func (*ClusterService) Get 

func (c *ClusterService) Get(gid string, name string) (*Cluster, *http.Response, error)

Get a cluster in the specified group. https://docs.atlas.mongodb.com/reference/api/clusters-get-one/

func (*ClusterService) List 

func (c *ClusterService) List(gid string) ([]Cluster, *http.Response, error)

List all clusters for the specified group. https://docs.atlas.mongodb.com/reference/api/clusters-get-all/

func (*ClusterService) Update 

func (c *ClusterService) Update(gid string, name string, clusterParams *Cluster) (*Cluster, *http.Response, error)

Update a cluster in the specified group. https://docs.atlas.mongodb.com/reference/api/clusters-modify-one/

type Container 

type Container struct {
	ID             string `json:"id,omitempty"`
	ProviderName   string `json:"providerName,omitempty"`
	AtlasCidrBlock string `json:"atlasCidrBlock,omitempty"`
	RegionName     string `json:"regionName,omitempty"`
	VpcID          string `json:"vpcId,omitempty"`
	GcpProjectID   string `json:"gcpProjectId,omitempty"`
	NetworkName    string `json:"networkName,omitempty"`
	Provisioned    bool   `json:"provisioned,omitempty"`
}

Container represents a Cloud Services Containers in MongoDB.

type ContainerService 

type ContainerService struct {
	// contains filtered or unexported fields
}

ContainerService provides methods for accessing MongoDB Atlas Containers API endpoints.

func (*ContainerService) Create 

func (c *ContainerService) Create(gid string, containerParams *Container) (*Container, *http.Response, error)

Create a container in the specified group. https://docs.atlas.mongodb.com/reference/api/vpc-create-container/

func (*ContainerService) Delete 

func (c *ContainerService) Delete(gid string, id string) (*http.Response, error)

Delete a container in the specified group. https://docs.atlas.mongodb.com/reference/api/vpc-delete-one-container/

func (*ContainerService) Get 

func (c *ContainerService) Get(gid string, id string) (*Container, *http.Response, error)

Get a container in the specified group. https://docs.atlas.mongodb.com/reference/api/vpc-get-container/

func (*ContainerService) List 

func (c *ContainerService) List(gid string, providerName string) ([]Container, *http.Response, error)

List all containers for the specified group. https://docs.atlas.mongodb.com/reference/api/vpc-get-containers-list/

func (*ContainerService) Update 

func (c *ContainerService) Update(gid string, id string, containerParams *Container) (*Container, *http.Response, error)

Update a container in the specified group. https://docs.atlas.mongodb.com/reference/api/vpc-update-container/

type DatabaseUser 

type DatabaseUser struct {
	GroupID         string `json:"groupId,omitempty"`
	Username        string `json:"username,omitempty"`
	Password        string `json:"password,omitempty"`
	DatabaseName    string `json:"databaseName,omitempty"`
	DeleteAfterDate string `json:"deleteAfterDate,omitempty"`
	Roles           []Role `json:"roles,omitempty"`
}

DatabaseUser represents MongoDB users in your cluster.

type DatabaseUserService 

type DatabaseUserService struct {
	// contains filtered or unexported fields
}

DatabaseUserService provides methods for accessing MongoDB Atlas DatabaseUsers API endpoints.

func (*DatabaseUserService) Create 

func (c *DatabaseUserService) Create(gid string, databaseUserParams *DatabaseUser) (*DatabaseUser, *http.Response, error)

Create a databaseUser in the specified group. https://docs.atlas.mongodb.com/reference/api/databaseUsers-create-one/

func (*DatabaseUserService) Delete 

func (c *DatabaseUserService) Delete(gid string, username string) (*http.Response, error)

Delete a databaseUser in the specified group. https://docs.atlas.mongodb.com/reference/api/databaseUsers-delete-one/

func (*DatabaseUserService) Get 

func (c *DatabaseUserService) Get(gid string, username string) (*DatabaseUser, *http.Response, error)

Get a databaseUser in the specified group. https://docs.atlas.mongodb.com/reference/api/database-users-get-single-user/

func (*DatabaseUserService) List 

func (c *DatabaseUserService) List(gid string) ([]DatabaseUser, *http.Response, error)

List all databaseUsers for the specified group. https://docs.atlas.mongodb.com/reference/api/database-users-get-all-users/

func (*DatabaseUserService) Update 

func (c *DatabaseUserService) Update(gid string, username string, databaseUserParams *DatabaseUser) (*DatabaseUser, *http.Response, error)

Update a databaseUser in the specified group. https://docs.atlas.mongodb.com/reference/api/databaseUsers-modify-one/

type Matcher 

type Matcher struct {
	FieldName string `json:"fieldName,omitempty"`
	Operator  string `json:"operator,omitempty"`
	Value     string `json:"value,omitempty"`
}

Matcher contains the metric(s) we'd like to alert on

type MetricThreshold 

type MetricThreshold struct {
	MetricName string  `json:"metricName,omitempty"`
	Operator   string  `json:"operator,omitempty"`
	Threshold  float64 `json:"threshold,omitempty"`
	Units      string  `json:"units,omitempty"`
	Mode       string  `json:"mode,omitempty"`
}

MetricThreshold describes how to know when to trigger this alert

type Notification 

type Notification struct {
	TypeName            string `json:"typeName,omitempty"`
	IntervalMin         int    `json:"intervalMin,omitempty"`
	DelayMin            int    `json:"delayMin,omitempty"`
	EmailEnabled        bool   `json:"emailEnabled,omitempty"`
	SMSEnabled          bool   `json:"smsEnabled,omitempty"`
	Username            string `json:"username,omitempty"`
	TeamID              string `json:"teamId,omitempty"`
	EmailAddress        string `json:"emailAddress,omitempty"`
	MobileNumber        string `json:"mobileNumber,omitempty"`
	NotificationToken   string `json:"notificationToken,omitempty"`
	RoomName            string `json:"roomName,omitempty"`
	ChannelName         string `json:"channelName,omitempty"`
	APIToken            string `json:"apiToken,omitempty"`
	OrgName             string `json:"orgName,omitempty"`
	FlowName            string `json:"flowName,omitempty"`
	FlowdockAPIToken    string `json:"flowdockApiToken,omitempty"`
	ServiceKey          string `json:"serviceKey,omitempty"`
	VictorOpsAPIKey     string `json:"victorOpsApiKey,omitempty"`
	VictorOpsRoutingKey string `json:"victorOpsRoutingKey,omitempty"`
	OpsGenieAPIKey      string `json:"opsGenieApiKey,omitempty"`
}

Notification is a way to get notified when a metric crosses the threshold

type Organization 

type Organization struct {
	ID   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

Organization represents an organization's connection information in MongoDB.

type OrganizationService 

type OrganizationService struct {
	// contains filtered or unexported fields
}

OrganizationService provides methods for accessing MongoDB Atlas Organizations API endpoints.

func (*OrganizationService) Create 

func (c *OrganizationService) Create(organizationParams *Organization) (*Organization, *http.Response, error)

Create an organization. https://docs.atlas.mongodb.com/reference/api/organization-create-one/

func (*OrganizationService) Delete 

func (c *OrganizationService) Delete(id string) (*http.Response, error)

Delete an organization https://docs.atlas.mongodb.com/reference/api/organization-delete-one/

func (*OrganizationService) Get 

func (c *OrganizationService) Get(id string) (*Organization, *http.Response, error)

Get information about the organization associated to org ID https://docs.atlas.mongodb.com/reference/api/organization-get-one/

func (*OrganizationService) List 

func (c *OrganizationService) List() ([]Organization, *http.Response, error)

List all organizations the authenticated user has access to. https://docs.atlas.mongodb.com/reference/api/organization-get-all/

func (*OrganizationService) Update 

func (c *OrganizationService) Update(id string, organizationParams *Organization) (*Organization, *http.Response, error)

Update name of an organization. https://docs.atlas.mongodb.com/reference/api/organization-rename/

type Peer 

type Peer struct {
	ID                  string `json:"id,omitempty"`
	ProviderName        string `json:"providerName,omitempty"`
	RouteTableCidrBlock string `json:"routeTableCidrBlock,omitempty"`
	VpcID               string `json:"vpcId,omitempty"`
	GcpProjectID        string `json:"gcpProjectId,omitempty"`
	AwsAccountID        string `json:"awsAccountId,omitempty"`
	ConnectionID        string `json:"connectionId,omitempty"`
	StatusName          string `json:"statusName,omitempty"`
	Status              string `json:"status,omitempty"`
	NetworkName         string `json:"networkName,omitempty"`
	ErrorStateName      string `json:"errorStateName,omitempty"`
	ErrorMessage        string `json:"errorMessage,omitempty"`
	ContainerID         string `json:"containerId,omitempty"`
	AccepterRegionName  string `json:"accepterRegionName,omitempty"`
}

Peer represents a peering connection information in MongoDB.

type PeerService 

type PeerService struct {
	// contains filtered or unexported fields
}

PeerService provides methods for accessing MongoDB Atlas Peers API endpoints.

func (*PeerService) Create 

func (c *PeerService) Create(gid string, peerParams *Peer) (*Peer, *http.Response, error)

Create a peer in the specified group. https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/

func (*PeerService) Delete 

func (c *PeerService) Delete(gid string, id string) (*http.Response, error)

Delete a peer in the specified group. https://docs.atlas.mongodb.com/reference/api/vpc-delete-peering-connection/

func (*PeerService) Get 

func (c *PeerService) Get(gid string, id string) (*Peer, *http.Response, error)

Get a peer in the specified group. https://docs.atlas.mongodb.com/reference/api/vpc-get-connection/

func (*PeerService) List 

func (c *PeerService) List(gid string, providerName string) ([]Peer, *http.Response, error)

List all peers for the specified group. https://docs.atlas.mongodb.com/reference/api/vpc-get-connections-list/

func (*PeerService) Update 

func (c *PeerService) Update(gid string, id string, peerParams *Peer) (*Peer, *http.Response, error)

Update a peer in the specified group. https://docs.atlas.mongodb.com/reference/api/vpc-update-peering-connection/

type PrivateIPMode 

type PrivateIPMode struct {
	Enabled bool `json:"enabled,omitempty"`
}

PrivateIPMode struct is the response from both the Enable and Disable functions

type PrivateIPModeService 

type PrivateIPModeService struct {
	// contains filtered or unexported fields
}

PrivateIPModeService provides many needfuls

func (*PrivateIPModeService) Disable 

func (p *PrivateIPModeService) Disable(gid string) (*http.Response, error)

Disable – Disables the PrivateIPMode on the Container https://docs.atlas.mongodb.com/reference/api/set-private-ip-mode-for-project/

func (*PrivateIPModeService) Enable 

func (p *PrivateIPModeService) Enable(gid string) (*http.Response, error)

Enable – Enables PrivateIPMode on the Container https://docs.atlas.mongodb.com/reference/api/set-private-ip-mode-for-project/

type Project 

type Project struct {
	ID           string `json:"id,omitempty"`
	Name         string `json:"name,omitempty"`
	OrgID        string `json:"orgId,omitempty"`
	Created      string `json:"created,omitempty"`
	ClusterCount int    `json:"clusterCount,omitempty"`
}

Project represents a projecting connection information in MongoDB.

type ProjectService 

type ProjectService struct {
	// contains filtered or unexported fields
}

ProjectService provides methods for accessing MongoDB Atlas Projects API endpoints.

func (*ProjectService) Create 

func (c *ProjectService) Create(projectParams *Project) (*Project, *http.Response, error)

Create a project. https://docs.atlas.mongodb.com/reference/api/project-create-one/

func (*ProjectService) Delete 

func (c *ProjectService) Delete(id string) (*http.Response, error)

Delete a project. https://docs.atlas.mongodb.com/reference/api/project-delete-one/

func (*ProjectService) Get 

func (c *ProjectService) Get(id string) (*Project, *http.Response, error)

Get information about the project associated to group id https://docs.atlas.mongodb.com/reference/api/project-get-one/

func (*ProjectService) GetByName 

func (c *ProjectService) GetByName(name string) (*Project, *http.Response, error)

GetByName information about the project associated to group name https://docs.atlas.mongodb.com/reference/api/project-get-one-by-name/

func (*ProjectService) List 

func (c *ProjectService) List() ([]Project, *http.Response, error)

List all projects the authenticated user has access to. https://docs.atlas.mongodb.com/reference/api/project-get-all/

type ProviderSettings 

type ProviderSettings struct {
	ProviderName        string `json:"providerName,omitempty"`
	BackingProviderName string `json:"backingProviderName,omitempty"`
	RegionName          string `json:"regionName,omitempty"`
	InstanceSizeName    string `json:"instanceSizeName,omitempty"`
	DiskIOPS            int    `json:"diskIOPS,omitempty"`
	EncryptEBSVolume    bool   `json:"encryptEBSVolume,omitempty"`
}

ProviderSettings is the configuration for the provisioned servers on which MongoDB runs. The available options are specific to the cloud service provider.

type ReplicationSpec 

type ReplicationSpec struct {
	Priority       int `json:"priority"`
	ElectableNodes int `json:"electableNodes"`
	ReadOnlyNodes  int `json:"readOnlyNodes"`
	AnalyticsNodes int `json:"analyticsNodes"`
}

ReplicationSpec describes a region’s priority in elections, and the number and type of MongoDB nodes Atlas deploys to the region.

type Role 

type Role struct {
	DatabaseName   string `json:"databaseName,omitempty"`
	CollectionName string `json:"collectionName,omitempty"`
	RoleName       string `json:"roleName,omitempty"`
}

Role allows the user to perform particular actions on the specified database. A role on the admin database can include privileges that apply to the other databases as well.

type Root 

type Root struct {
	AppName string `json:"appName"`
	Build   string `json:"build"`
}

Root is the response from the RootService.List.

type RootService 

type RootService struct {
	// contains filtered or unexported fields
}

RootService checks connectivity to MongoDB Atlas API.

func (*RootService) Get 

func (c *RootService) Get() (*Root, *http.Response, error)

Get the root resource which is the starting point for the Atlas API. https://docs.atlas.mongodb.com/reference/api/root/

type SnapshotSchedule 

type SnapshotSchedule struct {
	GroupID                        string  `json:"groupId,omitempty"`
	ClusterID                      string  `json:"clusterId,omitempty"`
	SnapshotIntervalHours          float64 `json:"snapshotIntervalHours,omitempty"`
	SnapshotRetentionDays          float64 `json:"snapshotRetentionDays,omitempty"`
	DailySnapshotRetentionDays     float64 `json:"dailySnapshotRetentionDays,omitempty"`
	PointInTimeWindowHours         float64 `json:"pointInTimeWindowHours,omitempty"`
	WeeklySnapshotRetentionWeeks   float64 `json:"weeklySnapshotRetentionWeeks,omitempty"`
	MonthlySnapshotRetentionMonths float64 `json:"monthlySnapshotRetentionMonths,omitempty"`
	ClusterCheckpintIntervalMin    float64 `json:"clusterCheckpintIntervalMin,omitempty"`
}

SnapshotSchedule represents a snapshot schedule's connection information in MongoDB.

type SnapshotScheduleService 

type SnapshotScheduleService struct {
	// contains filtered or unexported fields
}

SnapshotScheduleService provides methods for accessing MongoDB Atlas Snapshot Schedule API endpoints.

func (*SnapshotScheduleService) Get 

func (c *SnapshotScheduleService) Get(gid string, clusterName string) (*SnapshotSchedule, *http.Response, error)

Get the snapshot schedule for the specified cluster https://docs.atlas.mongodb.com/reference/api/snapshot-schedule-get/

func (*SnapshotScheduleService) Update 

func (c *SnapshotScheduleService) Update(gid string, clusterName string, snapshotScheduleParams *SnapshotSchedule) (*SnapshotSchedule, *http.Response, error)

Update the snapshot schedule for the specified cluster. https://docs.atlas.mongodb.com/reference/api/snapshot-schedule/

type Whitelist 

type Whitelist struct {
	CidrBlock string `json:"cidrBlock,omitempty"`
	Comment   string `json:"comment,omitempty"`
	GroupID   string `json:"groupId,omitempty"`
	IPAddress string `json:"ipAddress,omitempty"`
}

Whitelist represents a IP whitelist, which controls client access to your group’s MongoDB clusters. Clients can connect to clusters only from IP addresses on the whitelist.

type WhitelistService 

type WhitelistService struct {
	// contains filtered or unexported fields
}

WhitelistService provides methods for accessing MongoDB Atlas's Group IP Whitelist API endpoints.

func (*WhitelistService) Create 

func (c *WhitelistService) Create(gid string, whitelistParams []Whitelist) ([]Whitelist, *http.Response, error)

Create entries in a Group's whitelist. https://docs.atlas.mongodb.com/reference/api/whitelist/#add-entries-to-a-group-s-ip-whitelist

func (*WhitelistService) Delete 

func (c *WhitelistService) Delete(gid string, ip string) (*http.Response, error)

Delete an Entry from Group's IP Whitelist. https://docs.atlas.mongodb.com/reference/api/whitelist/#delete-an-entry-from-a-group-s-ip-whitelist

func (*WhitelistService) Get 

func (c *WhitelistService) Get(gid string, ip string) (*Whitelist, *http.Response, error)

Get the Entry for a Specific Address in a Group’s IP Whitelist https://docs.atlas.mongodb.com/reference/api/whitelist/#get-the-entry-for-a-specific-address-in-a-group-s-ip-whitelist

func (*WhitelistService) List 

func (c *WhitelistService) List(gid string) ([]Whitelist, *http.Response, error)

List a Group’s IP Whitelist. https://docs.atlas.mongodb.com/reference/api/whitelist/#get-a-group-s-ip-whitelist

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.