POST v1/{subscriptionID}/projects/families/{familyID}/friendlyInstanceID/validate?friendlyInstanceID={friendlyInstanceID}&projectID={projectID}

Validates a friendly instance ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subscriptionID

The Circle Subscription ID.

globally unique identifier

Required

familyID

The project family ID.

globally unique identifier

Required

friendlyInstanceID

The friendly instance ID to be validated.

string

Required

projectID

The project ID.

globally unique identifier

Optional

Body Parameters

None.

Response Information

Resource Description

Returns the friendly instance ID validation status.

ValidateFriendlyInstanceIDResultModel
NameDescriptionTypeAdditional information
Status

Gets the status of the friendly instance ID validation.

FriendlyInstanceIDValidationStatus

None.

Message

Gets the description of the friendly instance ID status.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Status": 1,
  "Message": "sample string 1"
}