Skip to main content

api_credential_applications

Creates, updates, deletes, gets or lists an api_credential_applications resource.

Overview​

Nameapi_credential_applications
TypeResource
Idovh.me.api_credential_applications

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
namestringName of this application
application_idintegerID of this Application (wire: applicationId)
application_keystringKey of this application (wire: applicationKey)
descriptionstringDescription of this application
statusstringStatus of this application (active, blocked, inactive, trusted)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectcredential_idGet associated application

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
api_hoststringThe OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
credential_idintegerCredential ID (wire: credentialId)

SELECT examples​

Get associated application

SELECT
name,
application_id,
application_key,
description,
status
FROM ovh.me.api_credential_applications
WHERE credential_id = '{{ credential_id }}' -- required
;