Cloud Credentials

Get Cloud Credential by ID

Get a single cloud credential by its Portal-assigned credential ID.

get/cloud-credentials/{credential_id}

Request

Path parameters

credential_idstring uuid required

Response

Cloud credential retrieved successfully

idstring uuid required
appliance_idstring uuid required

Appliance GUID owning this credential

appliance_namestring required

Appliance name

appliance_serialstring uuid required

Serial number of the edge appliance

appliance_credential_uuidstring required

UUID assigned to the credential by the appliance

namestring required
shortname'amazons3' | 'amazons3gov' | 'azure' | 'google' | 'googles3' | 'atmos' | 'ironmountain' | 'rackspace' | 'nirvanix' | 'synaptic' | 'castor' | 'delldx' | 'cloudone' | 'hp' | 'cleversafe' | 'vipr' | 'ibmcos' | 'hcp' | 's3_compatible' required

Cloud provider identity as used by NOC (shortname).

cred_type'amazons3' | 'amazons3gov' | 'azure' | 'ibmcos' | 'hcp' | 'vipr' | 'cleversafe' | 'googles3' | 's3_compatible' required

The underlying storage API/protocol (maps to 'type' in NOC response).

hostnamestring required
access_keystring required
vendor'customer' | 'private' | 'nasuni' required

Who provisions the cloud infrastructure.

notestring nullable
verify_certificatesboolean
certificatestring nullable
region_codestring nullable
is_stubboolean

True while this row is a Portal-created placeholder awaiting filer confirmation

status'synced' | 'pending' | 'failed' | 'creating' required

Derived status of a credential on a specific edge.

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.