[{"label":"Latest (4.4.0)","version":"latest"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]

vcf

Invite Member

Description

Invite a VMware Cloud Foundation to be member of a federation

Request

URL

post

https://sfo-vcf01.rainpole.io/v1/sddc-federation/membership-tokens

Copy

Request Body

InvitationSpec of type(s) application/json Required

Invitation Spec

{
	"inviteeFqdn": "string",
	"inviteeRole": "CONTROLLER",
	"tokenExpiryHours": 0
}

string

inviteeFqdn Optional

string

inviteeRole Optional

Possible values are: CONTROLLER , MANAGER , MEMBER , NOT_JOINED

number as float

tokenExpiryHours Optional

Response

Response Body

200 OK returns MembershipInvitation of type(s) application/json

{
	"controllerFqdn": [
		"string"
	],
	"error": {
		"error": "string",
		"errorPack": {
			"arguments": {},
			"component": "string",
			"defaultMessage": "string",
			"localBundle": "string",
			"messageKey": "string"
		},
		"suggestedRemedy": "string",
		"suggestedRemedyPack": {
			"arguments": {},
			"component": "string",
			"defaultMessage": "string",
			"localBundle": "string",
			"messageKey": "string"
		}
	},
	"invitationToken": "string",
	"inviteeFqdn": "string",
	"inviteeRole": "CONTROLLER"
}

array of string

controllerFqdn Optional

FederationOperationError

error Optional

string

invitationToken Optional

string

inviteeFqdn Optional

string

inviteeRole Optional

Possible values are: CONTROLLER , MANAGER , MEMBER , NOT_JOINED

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"inviteeFqdn":"string","inviteeRole":"CONTROLLER","tokenExpiryHours":0}' https://sfo-vcf01.rainpole.io/v1/sddc-federation/membership-tokens

vcf

Membership Token Operations

post

Invite Member

Invite Member

Request

URL

Request Body

Response

Response Body

No error details were provided in the OpenAPI specification.

Code Samples

cURL Command

On This Page

Membership Token Operations

Was this page helpful?