Skip to main content
API docs by Redocly

public/portworx/platform/onboard/apiv1/onboard.proto (version not set)

Download OpenAPI specification:Download

OnboardService

creates a new account registration request.

Request Body schema: application/json
required

account to be created and onboarded.

object (v1Meta)

Meta holds general resource metadata.

object (v1AccountConfig)

Account Configuration Info used for Registration.

Responses

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    }
}

For updating account subscription info.

path Parameters
accountRegistration.meta.uid
required
string

UID of the resource of the format -.

Request Body schema: application/json
required

account for which subscription info needs to be updated.

object (Metadata of the account.)

Metadata of the account.

object (v1AccountConfig)

Account Configuration Info used for Registration.

Responses

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    }
}