View a Command Template

GET /api/v1.2/command_templates/<id> or <name>

Use this API to view a specific command template by using its unique ID or name. Qubole assigns an unique identifier (ID) to each new command template once it is created.

Required Role

The following users can make this API call:

  • Users who belong to the system-user or system-admin group.

  • Users who belong to a group associated with a role that allows viewing a template. See Managing Groups and Managing Roles for more information.

Request API Syntax

Here is the syntax for the request API.

curl -i -X GET -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
"https://api.qubole.com/api/v1.2/command_templates/<id> or <name>"

Note

The above syntax uses https://api.qubole.com as the endpoint. Qubole provides other endpoints to access QDS that are described in Supported Qubole Endpoints on Different Cloud Providers.

Sample API Request

Here is the sample API request to view a template with its name as hivetemplate.

curl -i -X GET -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
"https://api.qubole.com/api/v1.2/command_templates/hivetemplate"