Skip to main content

modifyApplication

This mutation selects an Application by its ID or unique name and modifies it to have the given unique name, description, Propeller, and scopes.

If any of the optional arguments are omitted, those properties will be unchanged on the Application.

Learn more about Applications.

Arguments

  • input required modifyApplicationInput

    The fields for modifying an Application.

    • input.idOrUniqueName required idOrUniqueName

      The ID or unique name of the Application to modify.

    • input.uniqueName optional String

      The Application's new unique name.

    • input.description optional String

      The Application's new description.

    • input.propeller optional Propeller

      The Application's new Propeller.

      A Propeller determines your Application's query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.

      Learn more about Data Sources.

      • P1_X_SMALL

        Max records per second: 5,000,000 records per second

      • P1_SMALL

        Max records per second: 25,000,000 records per second

      • P1_MEDIUM

        Max records per second: 100,000,000 records per second

      • P1_LARGE

        Max records per second: 250,000,000 records per second

      • P1_X_LARGE

        Max records per second: 500,000,000 records per second

    • input.scopes optional array of ApplicationScope

      The Application's new API authorization scopes.

      The API operations an Application is authorized to perform.

      • ADMIN

        Grant read/write access to Data Sources, Data Pools, Metrics and Policies.

      • APPLICATION_ADMIN

        Grant read/write access to Applications.

      • DATA_POOL_QUERY

        Grant read access to query Data Pools.

      • DATA_POOL_STATS

        Grant read access to fetch column statistics from Data Pools.

      • METRIC_QUERY

        Grant read access to query Metrics.

      • METRIC_STATS

        Grant read access to fetch Dimension statistics from Metrics.

      • METRIC_READ

        Grant read access to Metrics.

        This does not allow querying Metrics. For that, see METRIC_QUERY.


Returns

Nullable ApplicationOrFailureResponse

The result of a mutation which creates or modifies an Application.

If successful, an ApplicationResponse will be returned; otherwise, a FailureResponse will be returned.