api_applications

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

Overview

Name	api_applications
Type	Resource
Id	ovh.me.api_applications

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Name of this application
application_id	integer	ID of this Application (wire: applicationId)
application_key	string	Key of this application (wire: applicationKey)
description	string	Description of this application
status	string	Status of this application (active, blocked, inactive, trusted)

list

API Application

Name	Datatype	Description
name	string	Name of this application
application_id	integer	ID of this Application (wire: applicationId)
application_key	string	Key of this application (wire: applicationKey)
description	string	Description of this application
status	string	Status of this application (active, blocked, inactive, trusted)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	application_id		Retrieve information about an application
list	select		x_pagination_mode	Retrieve all applications
delete	delete	application_id		Delete an application. It will revoke all credential belonging to this 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.

Name	Datatype	Description
api_host	string	The 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"}})
application_id	integer	Application ID (wire: applicationId)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Retrieve information about an application

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

list

Retrieve all applications

SELECT
name,
application_id,
application_key,
description,
status
FROM ovh.me.api_applications
WHERE x_pagination_mode = '{{ x_pagination_mode }}'
;

DELETE examples

delete

Delete an application. It will revoke all credential belonging to this application

DELETE FROM ovh.me.api_applications
WHERE application_id = '{{ application_id }}' --required
;