Applications

Propel Applications give your app credentials to access Propel via SQL or the API. Scopes control what the Application can do, and Propellers control the speed and cost of the queries.

​

Scopes

Scopes determine what an Application can do in Propel. You can create an Application with the following scopes:

​

Propellers

Propellers determine the speed of queries on a per-query basis. They control the number of rows per second that an individual query can read from a Data Pool.

By adjusting the Propeller size, you can optimize the balance between query performance and cost based on your specific needs.

For guidance on selecting the most appropriate Propeller for your use case, refer to our Choosing a Propeller guide.

​

Creating an Application

Follow these steps to create an Application:

mutation {
  createApplication(
    input: {
      uniqueName: "Dashboard"
      description: "My dashboard app"
      scopes: [DATA_POOL_QUERY]
      propeller: P1_X_SMALL
    }
  ) {
    ... on ApplicationResponse {
      application {
        id
        uniqueName
        description
        scopes
        propeller
        clientId
        secret
      }
    }
    ... on FailureResponse {
      error {
        message
      }
    }
  }
}

resource "propel_application" "dashboard" {
  unique_name = "Dashboard"
  description = "My dashboard app"
  scopes = [DATA_POOL_QUERY]
  propeller = P1_X_SMALL
}

​

Using credentials

Now that you have your Application created, you can find your credentials on the Applications details page.

​

With SQL

You can use the client ID and secret as the user and password when connecting to Propel via SQL.

​

With the API

To use your Application credentials with the Propel API, follow these steps:

1. Obtain an Access Token: Use your client ID and secret to request an access token. This token will be used to authenticate your API requests.

   Copy

   curl -X POST https://auth.us-east-2.propeldata.com/oauth2/token \
     -d "grant_type=client_credentials" \
     -d "client_id=YOUR_CLIENT_ID" \
     -d "client_secret=YOUR_CLIENT_SECRET"
   

   This request will return a JSON response containing your access token.

2. Use the Access Token: Include the access token in the Authorization header of your API requests.

   Copy

   curl -X POST https://api.us-east-2.propeldata.com/graphql \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
   

For a complete guide on API authentication, refer to our API authentication guide.