Equinix Fabric API v4 | Equinix Product Documentation

Create Service Profile Environment Action

Request

This API provides capability to perform actions on a service profile environment, such as validating an activation key.^Beta

Security

BearerAuth

Path

serviceProfileIdstring, (uuid)required

Service Profile UUID

environmentIdstringrequired

Provider Environment Reference

Bodyapplication/jsonrequired

typestring(EnvironmentActionTypeEnum)required

Environment action type

Value:"VALIDATE_ACTIVATION_KEY"

Example:"VALIDATE_ACTIVATION_KEY"

keyDetailsobject(ActivationKeyDetails)required

Activation Key Details ^Beta

Payload

{
  "type": "VALIDATE_ACTIVATION_KEY",
  "keyDetails": {
    "value": "key_here"
  }
}

Responses

Successful service profile environment action operation

Bodyapplication/json

hrefstring, (uri)read-only

Environment action URI

typestring(EnvironmentActionTypeEnum)

Environment action type

Value:"VALIDATE_ACTIVATION_KEY"

Example:"VALIDATE_ACTIVATION_KEY"

uuidstring, (uuid)

Equinix-assigned action identifier

Example:"3a58dd05-f46d-4b1d-a154-2e85c396ea62"

statestring(EnvironmentActionStateEnum)

Environment action state. ACTIVE - already used , INACTIVE - not used

Enum:"ACTIVE""INACTIVE"

Example:"ACTIVE"

keyDetailsobject(ActivationKeyDetails)

Activation Key Details ^Beta

changeLogobject(Changelog)

Change log

Response

{
  "href": "http://example.com",
  "type": "VALIDATE_ACTIVATION_KEY",
  "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
  "state": "ACTIVE",
  "keyDetails": {
    "value": "key_here",
    "providerId": "string",
    "accountId": "string",
    "bandwidth": 0,
    "region": "string"
  },
  "changeLog": {
    "createdBy": "johnsmith",
    "createdByFullName": "John Smith",
    "createdByEmail": "john.smith@example.com",
    "createdDateTime": "2020-11-06T07:00:00Z",
    "updatedBy": "johnsmith",
    "updatedByFullName": "John Smith",
    "updatedByEmail": "john.smith@example.com",
    "updatedDateTime": "2020-11-06T07:00:00Z",
    "deletedBy": "johnsmith",
    "deletedByFullName": "John Smith",
    "deletedByEmail": "john.smith@example.com",
    "deletedDateTime": "2020-11-06T07:00:00Z"
  }
}