Skip to content

README.md

Latest commit

 

History

History
791 lines (744 loc) · 63.6 KB

README.md

File metadata and controls

791 lines (744 loc) · 63.6 KB

Go API client for syncp

API for Synadia Control Plane / Synadia Cloud

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "github.com/synadia-io/control-plane-sdk-go/syncp"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value syncp.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), syncp.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value syncp.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), syncp.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using syncp.ContextOperationServerIndices and syncp.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), syncp.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), syncp.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost/api

Class Method HTTP request Description
AccountAPI AssignAccountTeamAppUser Post /core/beta/accounts/{accountId}/app-users/{teamAppUserId} Assign Team App User to Account
AccountAPI CreateAccountSkGroup Post /core/beta/accounts/{accountId}/account-sk-groups Create Account Signing Key Group
AccountAPI CreateAlertRule Post /core/beta/accounts/{accountId}/alert-rules Create Account Alert Rule
AccountAPI CreateKvBucket Post /core/beta/accounts/{accountId}/jetstream/kv-buckets Create KV Bucket
AccountAPI CreateMirror Post /core/beta/accounts/{accountId}/jetstream/mirrors Create Mirror
AccountAPI CreateObjectBucket Post /core/beta/accounts/{accountId}/jetstream/object-buckets Create Object Bucket
AccountAPI CreateOrUpdateNatsUserRevocation Put /core/beta/accounts/{accountId}/nats-user-revocations/{userNkeyPublic} Create or Update Revocation for a NATS User NKey
AccountAPI CreateStream Post /core/beta/accounts/{accountId}/jetstream/streams Create Stream
AccountAPI CreateStreamExport Post /core/beta/accounts/{accountId}/stream-exports Create Stream Export
AccountAPI CreateStreamImport Post /core/beta/accounts/{accountId}/stream-imports Create Stream Import
AccountAPI CreateSubjectExport Post /core/beta/accounts/{accountId}/subject-exports Create Subject Export
AccountAPI CreateSubjectImport Post /core/beta/accounts/{accountId}/subject-imports Create Subject Import
AccountAPI CreateUser Post /core/beta/accounts/{accountId}/nats-users Create NATS User
AccountAPI DeleteAccount Delete /core/beta/accounts/{accountId} Delete Account
AccountAPI DeleteAlertRule Delete /core/beta/accounts/{accountId}/alert-rules/{alertRuleId} Delete Account Alert Rule
AccountAPI DeleteNatsUserRevocation Delete /core/beta/accounts/{accountId}/nats-user-revocations/{userNkeyPublic} Delete a for a NATS User NKey
AccountAPI GetAccount Get /core/beta/accounts/{accountId} Get Account
AccountAPI GetAccountExport Get /core/beta/accounts/{accountId}/export Export Account Seeds
AccountAPI GetAccountInfo Get /core/beta/accounts/{accountId}/info Get Account Info
AccountAPI GetAccountMetrics Get /core/beta/accounts/{accountId}/metrics Get Account Metrics
AccountAPI GetAlertRule Get /core/beta/accounts/{accountId}/alert-rules/{alertRuleId} Get Account Alert Rule
AccountAPI GetJetStreamPlacementOptions Get /core/beta/accounts/{accountId}/jetstream/placement-options Get JetStream Placement Options
AccountAPI GetNatsUserRevocation Get /core/beta/accounts/{accountId}/nats-user-revocations/{userNkeyPublic} Get Revocation for a NATS User NKey
AccountAPI ListAccountConnections Get /core/beta/accounts/{accountId}/connections List Account Connections
AccountAPI ListAccountSkGroup Get /core/beta/accounts/{accountId}/account-sk-groups List Account Signing Key Groups
AccountAPI ListAccountTeamAppUsers Get /core/beta/accounts/{accountId}/app-users List Account Team App Users
AccountAPI ListAlertRules Get /core/beta/accounts/{accountId}/alert-rules List Account Alert Rules
AccountAPI ListJetStreamAssets Get /core/beta/accounts/{accountId}/jetstream List JetStream Assets
AccountAPI ListKvBuckets Get /core/beta/accounts/{accountId}/jetstream/kv-buckets List KV buckets
AccountAPI ListMirrors Get /core/beta/accounts/{accountId}/jetstream/mirrors List Mirrors
AccountAPI ListObjectBuckets Get /core/beta/accounts/{accountId}/jetstream/object-buckets List Object buckets
AccountAPI ListStreamExports Get /core/beta/accounts/{accountId}/stream-exports List Stream Exports
AccountAPI ListStreamExportsShared Get /core/beta/accounts/{accountId}/stream-imports/shared List Shared Stream Exports
AccountAPI ListStreamImports Get /core/beta/accounts/{accountId}/stream-imports List Stream Imports
AccountAPI ListStreams Get /core/beta/accounts/{accountId}/jetstream/streams List Streams
AccountAPI ListSubjectExports Get /core/beta/accounts/{accountId}/subject-exports List Subject Exports
AccountAPI ListSubjectExportsShared Get /core/beta/accounts/{accountId}/subject-imports/shared List Shared Subject Exports
AccountAPI ListSubjectImports Get /core/beta/accounts/{accountId}/subject-imports List Subject Imports
AccountAPI ListUsers Get /core/beta/accounts/{accountId}/nats-users List NATS Users
AccountAPI NatsCoreWebsocketViewer Get /core/beta/accounts/{accountId}/nats-core/websocket/view Subscribe to a NATS Core subject over websockets
AccountAPI RunAlertRule Get /core/beta/accounts/{accountId}/alert-rules/{alertRuleId}/run Run Account Alert Rule
AccountAPI UnAssignAccountTeamAppUser Delete /core/beta/accounts/{accountId}/app-users/{teamAppUserId} Unassign Team App User from Account
AccountAPI UnmanageAccount Delete /core/beta/accounts/{accountId}/unmanage Unmanage Account
AccountAPI UpdateAccount Patch /core/beta/accounts/{accountId} Update Account
AccountAPI UpdateAlertRule Patch /core/beta/accounts/{accountId}/alert-rules/{alertRuleId} Update Account Alert Rule
AdminAPI CheckAppAdmin Get /core/beta/admin/app-user Check for Admin User
AdminAPI CreateAppAdmin Post /core/beta/admin/app-user Create an App Admin User
AgentTokenAPI DeleteAgentToken Delete /core/beta/agent-tokens/{tokenId} Delete Agent Token
AlertAPI AcknowledgeAlert Patch /core/beta/alerts/{alertId}/acknowledge Acknowledge Alert
AlertAPI GetAlert Get /core/beta/alerts/{alertId} Get Alert
AppServiceAccountAPI CreateAppServiceAccountToken Post /core/beta/service-accounts/app/{serviceAccountId}/tokens Create Acess Token for App Service Account
AppServiceAccountAPI DeleteAppServiceAccount Delete /core/beta/service-accounts/app/{serviceAccountId} Delete App Service Account
AppServiceAccountAPI GetAppServiceAccount Get /core/beta/service-accounts/app/{serviceAccountId} Get App Service Account
AppServiceAccountAPI ListAppServiceAccountTokens Get /core/beta/service-accounts/app/{serviceAccountId}/tokens List Access Tokens for App Service Account
AppServiceAccountAPI UpdateAppServiceAccount Patch /core/beta/service-accounts/app/{serviceAccountId} Update App Service Account
AppServiceAccountTokensAPI DeleteAppServiceAccountToken Delete /core/beta/service-account-tokens/app/{tokenId} Delete App Service Account Token
AppServiceAccountTokensAPI GetAppServiceAccountToken Get /core/beta/service-account-tokens/app/{tokenId} Get App Service Account Token
AppServiceAccountTokensAPI UpdateAppServiceAccountToken Patch /core/beta/service-account-tokens/app/{tokenId} Update App Service Account Token
AppUserAPI AssignTeamAppUser Post /core/beta/app-users/{appUserId}/teams/{teamId} Assign App User to Team
AppUserAPI DeleteAppUser Delete /core/beta/app-users/{appUserId} Delete App User
AppUserAPI GetAppUser Get /core/beta/app-users/{appUserId} Get App User
AppUserAPI ListAppUserRoles Get /core/beta/app-users/{appUserId}/roles List Roles
AppUserAPI UpdateAppUser Patch /core/beta/app-users/{appUserId} Update App User
AuthCalloutAPI AddAuthCalloutTargetAccount Post /core/beta/auth-callout/{authCalloutId}/target-accounts Configure Target Account
AuthCalloutAPI AddAuthCalloutUser Post /core/beta/auth-callout/{authCalloutId}/users Create Auth Callout User
AuthCalloutAPI DeleteAuthCallout Delete /core/beta/auth-callout/{authCalloutId} Delete Auth Callout Config
AuthCalloutAPI DeleteAuthCalloutTargetAccount Delete /core/beta/auth-callout/{authCalloutId}/target-accounts/{targetAccountId} Delete Target Account
AuthCalloutAPI DeleteAuthCalloutUser Delete /core/beta/auth-callout/{authCalloutId}/users/{acUserId} Delete Control Account User
AuthCalloutAPI GetAuthCallout Get /core/beta/auth-callout/{authCalloutId} Auth Callout Config
AuthCalloutAPI ListAuthCalloutTargetAccounts Get /core/beta/auth-callout/{authCalloutId}/target-accounts Get Target Account List
AuthCalloutAPI ListAuthCalloutUsers Get /core/beta/auth-callout/{authCalloutId}/users Get Target Account List
AuthzAPI Check Post /core/beta/authz/check Check Authz Decisions
AuthzAPI ListPolicies Get /core/beta/authz/policies Get Policy List
AuthzAPI ListRoles Get /core/beta/authz/roles Get Authz roles List
ComponentVersionsAPI GetAvailableComponentVersions Get /core/beta/component-versions Get Available Component Versions
ComponentVersionsAPI GetAvailableComponentVersionsByType Post /core/beta/component-versions Get Available Component Versions By Type
IssuanceAPI GetNatsUserIssuance Get /core/beta/nats-user-issuances/{issuanceId} Get nats user issuance
KvBucketAPI CreateKvPullConsumer Post /core/beta/jetstream/kv-bucket/{streamId}/consumers/pull Create Pull Consumer
KvBucketAPI CreateKvPushConsumer Post /core/beta/jetstream/kv-bucket/{streamId}/consumers/push Create Push Consumer
KvBucketAPI DeleteKvBucket Delete /core/beta/jetstream/kv-bucket/{streamId} Delete KV Bucket
KvBucketAPI GetKvBucket Get /core/beta/jetstream/kv-bucket/{streamId} Get KV Bucket
KvBucketAPI ListKvConsumers Get /core/beta/jetstream/kv-bucket/{streamId}/consumers List Consumers
KvBucketAPI PurgeKvBucket Delete /core/beta/jetstream/kv-bucket/{streamId}/purge Purge KV Bucket
KvBucketAPI UpdateKvBucket Patch /core/beta/jetstream/kv-bucket/{streamId} Update KV Bucket
MirrorAPI CreateMirrorPullConsumer Post /core/beta/jetstream/mirror/{streamId}/consumers/pull Create Pull Consumer
MirrorAPI CreateMirrorPushConsumer Post /core/beta/jetstream/mirror/{streamId}/consumers/push Create Push consumer
MirrorAPI DeleteMirror Delete /core/beta/jetstream/mirror/{streamId} Delete Mirror
MirrorAPI GetMirror Get /core/beta/jetstream/mirror/{streamId} Get Mirror
MirrorAPI ListMirrorConsumers Get /core/beta/jetstream/mirror/{streamId}/consumers List Consumers
MirrorAPI PurgeMirror Delete /core/beta/jetstream/mirror/{streamId}/purge Purge Mirror
MirrorAPI UpdateMirror Patch /core/beta/jetstream/mirror/{streamId} Update Mirror
NatsUserAPI AssignNatsUserTeamAppUser Post /core/beta/nats-users/{userId}/app-users/{teamAppUserId} Assign Team App User to NATS User
NatsUserAPI CopyNatsUser Post /core/beta/nats-users/{userId}/copy Copy nats user
NatsUserAPI DeleteNatsUser Delete /core/beta/nats-users/{userId} Delete NATS User
NatsUserAPI DownloadNatsUserBearerJwt Post /core/beta/nats-users/{userId}/bearer-jwt Get Bearer JWT
NatsUserAPI DownloadNatsUserCreds Post /core/beta/nats-users/{userId}/creds Get Creds
NatsUserAPI DownloadNatsUserHttpGwToken Post /core/beta/nats-users/{userId}/http-gw-token Get HTTP Gateway Token
NatsUserAPI GetNatsUser Get /core/beta/nats-users/{userId} Get NATS User
NatsUserAPI ListNatsUserConnections Get /core/beta/nats-users/{userId}/connections List NATs User Connections
NatsUserAPI ListNatsUserIssuances Get /core/beta/nats-users/{userId}/issuances List nats user issuances
NatsUserAPI ListNatsUserTeamAppUsers Get /core/beta/nats-users/{userId}/app-users List Team App Users
NatsUserAPI RotateNatsUser Post /core/beta/nats-users/{userId}/rotate Rotate nats user nkey and seed
NatsUserAPI UnAssignNatsUserTeamAppUser Delete /core/beta/nats-users/{userId}/app-users/{teamAppUserId} Unassign Team App User from NATS User
NatsUserAPI UpdateNatsUser Patch /core/beta/nats-users/{userId} Update NATS User
ObjectBucketAPI CreateObjPullConsumer Post /core/beta/jetstream/object-bucket/{streamId}/consumers/pull Create Pull Consumer
ObjectBucketAPI CreateObjPushConsumer Post /core/beta/jetstream/object-bucket/{streamId}/consumers/push Create Push Consumer
ObjectBucketAPI DeleteObjectBucket Delete /core/beta/jetstream/object-bucket/{streamId} Delete Object Bucket
ObjectBucketAPI GetObjectBucket Get /core/beta/jetstream/object-bucket/{streamId} Get Object Bucket
ObjectBucketAPI ListObjConsumers Get /core/beta/jetstream/object-bucket/{streamId}/consumers List Consumers
ObjectBucketAPI PurgeObjBucket Delete /core/beta/jetstream/object-bucket/{streamId}/purge Purge Object Bucket
ObjectBucketAPI UpdateObjectBucket Patch /core/beta/jetstream/object-bucket/{streamId} Update Object Bucket
OidcProviderAPI CreateOidcProvider Post /core/beta/oidc-providers Create OIDC Provider
OidcProviderAPI DeleteOidcProvider Delete /core/beta/oidc-providers/{oidcProviderId} Delete OIDC Provider
OidcProviderAPI GetOidcProvider Get /core/beta/oidc-providers/{oidcProviderId} Get OIDC Provider
OidcProviderAPI ListOidcDefaultProvider Get /core/beta/oidc-providers/defaults List OIDC Provider Defaults
OidcProviderAPI ListOidcProviders Get /core/beta/oidc-providers List OIDC Providers
OidcProviderAPI UpdateOidcProvider Patch /core/beta/oidc-providers/{oidcProviderId} Update OIDC Provider
PersonalAccessTokenAPI DeletePersonalAccessToken Delete /core/beta/personal-access-tokens/{tokenId} Delete Personal Access Token
PersonalAccessTokenAPI GetPersonalAccessToken Get /core/beta/personal-access-tokens/{tokenId} Get Personal Access Token
PersonalAccessTokenAPI UpdatePersonalAccessToken Patch /core/beta/personal-access-tokens/{tokenId} Update Personal Access Token
PlatformComponentsAPI PlatformComponentConnect Post /core/beta/platform-components/connect Connect a Platform Component
PullConsumerAPI DeletePullConsumer Delete /core/beta/consumers/pull/{consumerId} Delete Pull Consumer
PullConsumerAPI GetPullConsumerInfo Get /core/beta/consumers/pull/{consumerId} Get Pull Consumer
PullConsumerAPI UpdatePullConsumer Patch /core/beta/consumers/pull/{consumerId} Update Pull Consumer
PushConsumerAPI DeletePushConsumer Delete /core/beta/consumers/push/{consumerId} Delete Push Consumer
PushConsumerAPI GetPushConsumerInfo Get /core/beta/consumers/push/{consumerId} Get Push Consumer
PushConsumerAPI UpdatePushConsumer Patch /core/beta/consumers/push/{consumerId} Update Push Consumer
SessionAPI AcceptTerms Post /core/beta/terms/accept Accept terms
SessionAPI CreateAppServiceAccount Post /core/beta/service-accounts/app Create App Service Account
SessionAPI CreateAppUser Post /core/beta/app-users Create App User
SessionAPI CreateAppUserAccessToken Post /core/beta/personal-access-tokens Create Personal Access Token
SessionAPI CreateTeam Post /core/beta/teams Create Team
SessionAPI DecideInvitation Post /core/beta/invitations/{teamId} Accept or reject team invitation
SessionAPI GetVersion Get /core/beta/version Get Version
SessionAPI ListAlerts Get /core/beta/alerts List Alerts
SessionAPI ListAppServiceAccounts Get /core/beta/service-accounts/app List App Service Accounts
SessionAPI ListAppUserAccessTokens Get /core/beta/personal-access-tokens List Personal Access Tokens
SessionAPI ListAppUsers Get /core/beta/app-users List App Users
SessionAPI ListInvitations Get /core/beta/invitations List of pending invitations
SessionAPI ListTeams Get /core/beta/teams List Teams
SigKeyAPI DeleteAccountSk Delete /core/beta/account-sks/{keyId} Delete Account Signing
SigKeyAPI GetAccountSk Get /core/beta/account-sks/{keyId} Get Account Signing
SigKeyAPI UpdateAccountSk Patch /core/beta/account-sks/{keyId} Update Account Signing
SigKeyGroupAPI CopyAccountSkGroup Post /core/beta/account-sk-groups/{groupId}/copy Copy Account SK Group
SigKeyGroupAPI DeleteAccountSkGroup Delete /core/beta/account-sk-groups/{groupId} Delete Account Signing Key Group
SigKeyGroupAPI GetAccountSkGroup Get /core/beta/account-sk-groups/{groupId} Get Account Signing Key Group
SigKeyGroupAPI ListAccountSKGroupUsers Get /core/beta/account-sk-groups/{groupId}/nats-users List NATS Users
SigKeyGroupAPI ListAccountSkGroupKeys Get /core/beta/account-sk-groups/{groupId}/account-sks List Signing Keys
SigKeyGroupAPI RotateAccountSk Post /core/beta/account-sk-groups/{groupId}/rotate-sk Roate Active Signing Key
SigKeyGroupAPI UpdateAccountSkGroup Patch /core/beta/account-sk-groups/{groupId} Update Account Signing Key Group
StreamAPI CreatePullConsumer Post /core/beta/jetstream/stream/{streamId}/consumers/pull Create Pull Consumer
StreamAPI CreatePushConsumer Post /core/beta/jetstream/stream/{streamId}/consumers/push Create Push Consumer
StreamAPI DeleteStream Delete /core/beta/jetstream/stream/{streamId} Delete Stream
StreamAPI GetStreamInfo Get /core/beta/jetstream/stream/{streamId} Get Stream
StreamAPI ListConsumers Get /core/beta/jetstream/stream/{streamId}/consumers List Consumers
StreamAPI PurgeStream Delete /core/beta/jetstream/stream/{streamId}/purge Purge Stream
StreamAPI UpdateStream Patch /core/beta/jetstream/stream/{streamId} Update Stream
StreamExportAPI CreateStreamShares Post /core/beta/stream-exports/{streamExportId}/shares Create Stream Shares
StreamExportAPI DeleteStreamExport Delete /core/beta/stream-exports/{streamExportId} Delete Stream Export
StreamExportAPI DeleteStreamShare Delete /core/beta/stream-exports/{streamExportId}/shares/{targetAccountNKeyPublic} Delete Stream Share
StreamExportAPI GetStreamExport Get /core/beta/stream-exports/{streamExportId} Get Stream Export
StreamExportAPI ListStreamShares Get /core/beta/stream-exports/{streamExportId}/shares List Stream Shares
StreamImportAPI DeleteStreamImport Delete /core/beta/stream-imports/{streamImportId} Delete Stream Import
StreamImportAPI GetStreamImport Get /core/beta/stream-imports/{streamImportId} Get Stream Import
SubjectExportAPI CreateSubjectShares Post /core/beta/subject-exports/{subjectExportId}/shares Create Subject Shares
SubjectExportAPI DeleteSubjectExport Delete /core/beta/subject-exports/{subjectExportId} Delete Subject Export
SubjectExportAPI DeleteSubjectShare Delete /core/beta/subject-exports/{subjectExportId}/shares/{targetAccountNKeyPublic} Delete Subject Share
SubjectExportAPI GetSubjectExport Get /core/beta/subject-exports/{subjectExportId} Get Subject Export
SubjectExportAPI ListSubjectShares Get /core/beta/subject-exports/{subjectExportId}/shares List Subject Shares
SubjectExportAPI UpdateSubjectExport Patch /core/beta/subject-exports/{subjectExportId} Update Subject Export
SubjectImportAPI DeleteSubjectImport Delete /core/beta/subject-imports/{subjectImportId} Delete Subject Import
SubjectImportAPI GetSubjectImport Get /core/beta/subject-imports/{subjectImportId} Get Subject Import
SubjectImportAPI UpdateSubjectImport Patch /core/beta/subject-imports/{subjectImportId} Update Subject Import
SystemAPI AssignSystemTeamAppUser Post /core/beta/systems/{systemId}/app-users/{teamAppUserId} Assign Team App User to System
SystemAPI BulkShare Post /core/beta/systems/{systemId}/bulk/shares Share assets across accounts
SystemAPI CreateAccount Post /core/beta/systems/{systemId}/accounts Create Account
SystemAPI CreateSystemAlertRule Post /core/beta/systems/{systemId}/alert-rules Create System Alert Rule
SystemAPI DeleteSystem Delete /core/beta/systems/{systemId} Delete System
SystemAPI DeleteSystemAlertRule Delete /core/beta/systems/{systemId}/alert-rules/{alertRuleId} Delete System Alert Rule
SystemAPI EnableAuthCallout Post /core/beta/systems/{systemId}/auth-callout Enable Auth Callout For System
SystemAPI GetComponentToken Get /core/beta/systems/{systemId}/platform-components/{id}/tokens Get a component access token
SystemAPI GetCurrentAgentToken Get /core/beta/systems/{systemId}/agent-tokens/current Get Current Agent Token
SystemAPI GetSystem Get /core/beta/systems/{systemId} Get System
SystemAPI GetSystemAlertRule Get /core/beta/systems/{systemId}/alert-rules/{alertRuleId} Get System Alert Rule
SystemAPI GetSystemExport Get /core/beta/systems/{systemId}/export Export System Seeds
SystemAPI GetSystemLimits Get /core/beta/systems/{systemId}/limits Get System Limits
SystemAPI GetSystemPrometheusMetrics Get /core/beta/systems/{systemId}/prometheus-metrics Get Prometheus Metrics
SystemAPI ImportAccount Post /core/beta/systems/{systemId}/import-account Import Account
SystemAPI ImportUser Post /core/beta/systems/{systemId}/import-user Import User
SystemAPI ListAccounts Get /core/beta/systems/{systemId}/accounts List Accounts
SystemAPI ListAccountsOverviewMetrics Get /core/beta/systems/{systemId}/accounts-overview-metrics List Accounts overview metrics
SystemAPI ListAgentTokens Get /core/beta/systems/{systemId}/agent-tokens List Agent Tokens
SystemAPI ListAuthCalloutAuthenticators Get /core/beta/systems/{systemId}/auth-callout/authenticators Get List of Available Authenticators
SystemAPI ListAuthCalloutConfigs Get /core/beta/systems/{systemId}/auth-callout List Auth Callout Configs
SystemAPI ListClusters Get /core/beta/systems/{systemId}/nats-clusters List Clusters
SystemAPI ListConnections Get /core/beta/systems/{systemId}/connections List Connections
SystemAPI ListServers Get /core/beta/systems/{systemId}/servers List Servers
SystemAPI ListSystemAlertRules Get /core/beta/systems/{systemId}/alert-rules List System Alert Rules
SystemAPI ListSystemInfoAccounts Get /core/beta/systems/{systemId}/info/accounts List System Accounts Info
SystemAPI ListSystemInfoServers Get /core/beta/systems/{systemId}/info/servers List System Servers info
SystemAPI ListSystemTeamAppUsers Get /core/beta/systems/{systemId}/app-users List System Team App Users
SystemAPI RotateAgentToken Post /core/beta/systems/{systemId}/agent-tokens Rotate Agent Token
SystemAPI RunSystemAlertRule Get /core/beta/systems/{systemId}/alert-rules/{alertRuleId}/run Run System Alert Rule
SystemAPI SystemJWTSync Post /core/beta/systems/{systemId}/jwt-sync Re-sync JWTs of all accounts in this system
SystemAPI UnAssignSystemTeamAppUser Delete /core/beta/systems/{systemId}/app-users/{teamAppUserId} Unassign Team App User from System
SystemAPI UnmanageSystem Delete /core/beta/systems/{systemId}/unmanage Unmanage System
SystemAPI UpdatePlatformComponents Patch /core/beta/systems/{systemId}/platform-components Update Platform Components for System
SystemAPI UpdateSystem Patch /core/beta/systems/{systemId} Update System
SystemAPI UpdateSystemAlertRule Patch /core/beta/systems/{systemId}/alert-rules/{alertRuleId} Update System Alert Rules
TeamAPI CreateSystem Post /core/beta/teams/{teamId}/systems Create System
TeamAPI CreateTeamServiceAccount Post /core/beta/teams/{teamId}/service-accounts Create Team Service Account
TeamAPI DeleteTeam Delete /core/beta/teams/{teamId} Delete Team
TeamAPI GetTeam Get /core/beta/teams/{teamId} Get Team
TeamAPI GetTeamLimits Get /core/beta/teams/{teamId}/team-limits Get Team Limits
TeamAPI ImportSystem Post /core/beta/teams/{teamId}/import-system Import a System
TeamAPI InviteAppUser Post /core/beta/teams/{teamId}/app-users/invitations Invite App Users
TeamAPI LeaveTeam Post /core/beta/teams/{teamId}/app-users/leave Leave Team
TeamAPI ListTeamAppUsers Get /core/beta/teams/{teamId}/app-users List App Users
TeamAPI ListTeamInfoAppUsers Get /core/beta/teams/{teamId}/info/app-users List info of App Users in Team
TeamAPI ListTeamServiceAccounts Get /core/beta/teams/{teamId}/service-accounts List Team Service Accounts
TeamAPI ListTeamSystems Get /core/beta/teams/{teamId}/systems List Systems
TeamAPI UnAssignTeamAppUser Delete /core/beta/teams/{teamId}/app-users/{appUserId} Unassign App User from Team
TeamAPI UpdateTeam Patch /core/beta/teams/{teamId} Update Team
TeamAPI UpdateTeamAppUser Patch /core/beta/teams/{teamId}/app-users/{appUserId} Update App User Team Assignment
TeamServiceAccountAPI CreateTeamServiceAccountToken Post /core/beta/service-accounts/team/{serviceAccountId}/tokens Create Acess Token for Team Service Account
TeamServiceAccountAPI DeleteTeamServiceAccount Delete /core/beta/service-accounts/team/{serviceAccountId} Delete Team Service Account
TeamServiceAccountAPI GetTeamServiceAccount Get /core/beta/service-accounts/team/{serviceAccountId} Get Team Service Account
TeamServiceAccountAPI ListTeamServiceAccountTokens Get /core/beta/service-accounts/team/{serviceAccountId}/tokens List Access Tokens for Team Service Account
TeamServiceAccountAPI UpdateTeamServiceAccount Patch /core/beta/service-accounts/team/{serviceAccountId} Update Team Service Account
TeamServiceAccountTokensAPI DeleteTeamServiceAccountToken Delete /core/beta/service-account-tokens/team/{tokenId} Delete Team Service Account Token
TeamServiceAccountTokensAPI GetTeamServiceAccountToken Get /core/beta/service-account-tokens/team/{tokenId} Get Team Service Account Token
TeamServiceAccountTokensAPI UpdateTeamServiceAccountToken Patch /core/beta/service-account-tokens/team/{tokenId} Update Team Service Account Token
WorkloadsAPI GetWorkloadLimits Get /workloads/alpha/{accountId}/limits Get Workloads limits

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), syncp.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

sessionAuth

  • Type: API key
  • API key parameter name: control_plane_session
  • Location:

Note, each API key must be added to a map of map[string]APIKey where the key is: control_plane_session and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		syncp.ContextAPIKeys,
		map[string]syncp.APIKey{
			"control_plane_session": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions and generic types to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author
⚡