Skip to main content
Sign in Dashboard Get started
  1. Docs
  2. Reference
  3. REST API Docs
  4. Resources Under Management

Resources Under Management

    Resources Under Management (RUM) provides information about the cloud resources managed by Pulumi across your organization. The RUM API allows you to track resource counts over time with various time aggregations.

    Get Usage Summary Discovered Resource Hours

    ▼
    GET /api/orgs/{orgName}/discovered-resources/summary

    GetUsageSummaryDiscoveredResourceHours handles request to fetch the summary of discovered resources for an organization.

    Request Parameters

    • orgName string path required
      The organization name
    • granularity string query required
      Time granularity for aggregation. Hourly granularity is limited to a 2-day lookback.
    • lookbackDays integer query optional
      Number of days to look back from the current time. Must be positive; when granularity is ‘hourly’ the value must not exceed 2. Mutually exclusive with lookbackStart; exactly one must be provided.
    • lookbackStart integer query optional
      Unix timestamp (seconds since epoch) for the start of the lookback period. Must be positive, in the past, and within the last year. Mutually exclusive with lookbackDays; exactly one must be provided.

    Responses

    200 OK
    Schema: GetResourceCountSummaryResponse
    • summary array[ResourceCountSummary] required
      The list of resource count summaries
    • ↳ year integer required
      The 4-digit year.
    • ↳ month integer optional
      The month of the year. Ranges from 1 to 12.
    • ↳ day integer optional
      The day of month. Ranges from 1 to 31.
    • ↳ weekNumber integer optional
      The week number in the year with Sunday marking the start of the week. Ranges from 0-53.
    • ↳ hour integer optional
      The hour of the day. Ranges from 0 to 23.
    • ↳ resources integer required
      The RUM (total number of resources under management at a given time). Calculated by getting the average of the all the resources for the given time frame.
    • ↳ resourceHours integer required
      The RHUM, which is the number of hours the resources under management have been running. Calculated by getting the sum of all the resources for the given time frame. 1 resource hour = 1 Pulumi credit.
    • ↳ tags map[string]string optional
      Tag key/value pairs for this usage breakdown entry. Only present when a tag breakdown is requested. Keys correspond to the tagKeys field in the response.
    • tagKeys array[string] optional
      The list of tag keys present in the breakdown entries. Only present when a tag breakdown is requested.
    204 No Content

    Get Usage Summary Resource Hours

    ▼
    GET /api/orgs/{orgName}/resources/summary

    GetUsageSummaryResourceHours handles request to fetch the summary of resources under management (RUM) and resource hours under management (RHUM) for an organization.

    Request Parameters

    • orgName string path required
      The organization name
    • granularity string query required
      Time granularity for aggregation. Hourly granularity is limited to a 2-day lookback.
    • lookbackDays integer query optional
      Number of days to look back from the current time. Must be positive; when granularity is ‘hourly’ the value must not exceed 2. Mutually exclusive with lookbackStart; exactly one must be provided.
    • lookbackStart integer query optional
      Unix timestamp (seconds since epoch) for the start of the lookback period. Must be positive, in the past, and within the last year. Mutually exclusive with lookbackDays; exactly one must be provided.

    Responses

    200 OK
    Schema: GetResourceCountSummaryResponse
    • summary array[ResourceCountSummary] required
      The list of resource count summaries
    • ↳ year integer required
      The 4-digit year.
    • ↳ month integer optional
      The month of the year. Ranges from 1 to 12.
    • ↳ day integer optional
      The day of month. Ranges from 1 to 31.
    • ↳ weekNumber integer optional
      The week number in the year with Sunday marking the start of the week. Ranges from 0-53.
    • ↳ hour integer optional
      The hour of the day. Ranges from 0 to 23.
    • ↳ resources integer required
      The RUM (total number of resources under management at a given time). Calculated by getting the average of the all the resources for the given time frame.
    • ↳ resourceHours integer required
      The RHUM, which is the number of hours the resources under management have been running. Calculated by getting the sum of all the resources for the given time frame. 1 resource hour = 1 Pulumi credit.
    • ↳ tags map[string]string optional
      Tag key/value pairs for this usage breakdown entry. Only present when a tag breakdown is requested. Keys correspond to the tagKeys field in the response.
    • tagKeys array[string] optional
      The list of tag keys present in the breakdown entries. Only present when a tag breakdown is requested.
    204 No Content