1. Home
    2. Prisma
    3. Prisma Cloud
    4. Prisma Cloud Microsegmentation Administrator's Guide
    5. Microsegmentation Console API
    6. Visualization resources

    Visualization resources

    visualization/depmaps

    DependencyMap

    Returns a data structure representing the graph of all processing units and their connections in a particular namespace, in a given time window. To pass the time window you can use the query parameters startAbsolute, endAbsolute, startRelative, endRelative.
    For example:

    Relations

    Retrieves the dependency map of a namespace.
    Parameters:
    Mandatory Parameters

    Attributes

    The edges of the map.
    Provides information about the group values.
    Refers to the nodes of the map.
    Type: []string
    Provides suggested views based on relevant tags.

    GraphEdge

    Represents an edge from the dependency map.

    Example

    {
  "acceptedFlows": false,
  "destinationType": "ProcessingUnit",
  "encrypted": false,
  "observedAcceptedFlows": false,
  "observedEncrypted": false,
  "observedRejectedFlows": false,
  "rejectedFlows": false,
  "sourceType": "ProcessingUnit"
}

    Relations

    Retrieves the graph edges.
    Parameters:
    Mandatory Parameters

    Attributes

    Type: boolean
    Number of accepted flows in the edge.
    Type: string
    Name of the remote destination controller if different than the current one.
    Type: string
    ID of the destination GraphNode of the edge.
    Type of the destination GraphNode of the edge.
    Type: boolean
    The number of encrypted flows in the edge.
    Type: time
    Contains the date when the edge was first seen.
    Type: string
    Identifier of the edge.
    Type: time
    Contains the date when the edge was last seen.
    Type: string
    Namespace of the object that reported the flow.
    Type: boolean
    Number of accepted observed flows.
    Type: boolean
    Number of encrypted observed flows.
    Type: boolean
    Number of rejected observed flows.
    Type: boolean
    Number of rejected flows in the edge.
    Type: string
    Namespace of the object that was targeted by the flow.
    Type: string
    Name of the remote source controller if different than the current one.
    Type: string
    ID of the source GraphNode of the edge.
    Type of the source GraphNode of the edge.

    GraphGroup

    Represents an group of nodes from the dependency map.

    Attributes

    Type: string
    Identifier of the group.
    Type: string
    Color to use for the group.
    List of tags that were used to create this group.
    Type: string
    Name of the group.
    Type: string
    ID of the parent group, if any.

    GraphNode

    Represents an node from the dependency map.

    Example

    {
  "type": "Docker",
  "unreachable": false
}

    Relations

    Retrieves the pu nodes.
    Parameters:
    Mandatory Parameters

    Attributes

    Type: string
    Identifier of object represented by the node.
    Type: string
    Enforcement status of processing unit represented by the node.
    Type: time
    Contains the date when the edge was first seen.
    Type: string
    ID of the group the node is eventually part of.
    Type: []string
    List of images.
    Type: time
    Contains the date when the edge was last seen.
    Type: string
    Name of object represented by the node.
    Type: string
    Namespace of object represented by the node.
    Type: string
    Status of object represented by the node.
    Type: []string
    Tags of object represented by the node.
    Type of object represented by the node.
    Type: boolean
    If true the node is marked as unreachable.
    Type: string
    Tags of object represented by the node.

    IPInfo

    Provides information about IP address resolution.

    Relations

    Returns information about an IP address given as parameters.
    Parameters:
    Mandatory Parameters

    Attributes

    Type: string
    The IP address.
    Type: string
    Error that occurred during resolution.
    List of DNS records associated with the IP address.

    PolicyGraph

    Returns a data structure representing the policy graph of all selected processing units and their possible connectivity based on the current policies associated with the namespace. Users can define a selector of processing units in which they are interested or define the identity tags of a virtual processing unit that is not yet activated.

    Example

    {
  "policyType": "Authorization",
  "selectors": [
    [
      "$identity=processingunit"
    ]
  ]
}

    Relations

    Retrieve a policy graph.
    Parameters:
    • view (string): Set the view query for grouping the dependency map.

    Attributes

    Type: []string
    The set of tags that a future-activated processing unit will have for which the user wants to evaluate policies and understand its connectivity options.
    Contains the output of the policy evaluation. It is the same type of dependency map as created by other APIs.
    Identifies the type of policy that should be analyzed: Authorization (default), Infrastructure, or Combined.
    Default value:
    "Authorization"
    Contains the tag expression that a processing unit must match in order to evaluate policy for it.

    SuggestedPolicy

    Allows you to obtain network policy suggestions.

    Relations

    Retrieves a list of network policy suggestions.
    Parameters:
    Mandatory Parameters

    Attributes

    List of suggested network policies.

    visualization/metrics

    MetricsQuery

    Prometheus compatible endpoint to evaluate a Prometheus query expression at a single instant or over a range of time. This can be used to retrieve back Aporeto specific metrics for a given namespace. All queries are protected within the namespace of the caller.

    Example

    {
  "query": "flows{namespace=~\"/mycompany.*\"}",
  "time": "2015-07-01T20:11:00.781Z"
}

    Relations

    Prometheus compatible endpoint to evaluate a Prometheus query expression at a single instant or over a range of time.
    Parameters:
    • query (string): Prometheus expression query string.
    • time (string): Evaluation timestamp <rfc3339
      unix_timestamp>.
    Mandatory Parameters
    Prometheus compatible endpoint to evaluate a Prometheus query expression at a single instant or over a range of time. This has the same behavior as the GET request, however it is useful when specifying a large query that may breach server-side URL character limits. In such a case, you can URL-encode the parameters that would be used for a GET request directly in the request body by using the POST method and Content-Type: application/x-www-form-urlencoded header.

    Attributes

    Type: string
    Prometheus expression query string.
    Type: string
    Evaluation timestamp <rfc3339
    unix_timestamp>.

    MetricsQueryRange

    Prometheus compatible endpoint to evaluate an expression query over a range of time. This can be used to retrieve back Aporeto specific metrics for a given namespace. All queries are protected within the namespace of the caller.

    Example

    {
  "end": "2015-07-01T20:11:00.781Z",
  "query": "flows{namespace=~\"/mycompany.*\"}",
  "start": "2015-07-01T20:11:00.781Z",
  "step": "15s"
}

    Relations

    Evaluates an expression query over a range of time returning a "matrix" result type.
    Parameters:
    • end (string): End timestamp <rfc3339
      unix_timestamp>.
    • query (string): Prometheus expression query string.
    • start (string): Start timestamp <rfc3339
      unix_timestamp>.
    • step (string): Query resolution step width in duration format or float number of seconds.
    Mandatory Parameters
    Evaluates an expression query over a range of time returning a "matrix" result. This has the same behavior as the GET request, however it is useful when specifying a large query that may breach server-side URL character limits. In such a case, you can URL-encode the parameters that would be used for a GET request directly in the request body by using the POST method and Content-Type: application/x-www-form-urlencoded header.

    Attributes

    Type: string
    End timestamp <rfc3339
    unix_timestamp>.
    Type: string
    Prometheus expression query string.
    Type: string
    Start timestamp <rfc3339
    unix_timestamp>.
    Type: string
    Query resolution step width in duration format or float number of seconds.

    visualization/reportsquery

    ReportsQuery

    Supports querying Aporeto reports. All queries are protected within the namespace of the user.

    Example

    {
  "report": "Flows"
}

    Relations

    Sends a query on report data.
    Parameters:
    Mandatory Parameters

    Attributes

    List of DNSLookupReports.
    List of ConnectionExceptionReports.
    List of CounterReports.
    List of EnforcerReports.
    List of EventLogs.
    List of FlowReports.
    List of PacketReports.
    Name of the report type to query.
    Default value:
    "Flows"

    visualization/statsquery

    StatsInfo

    Lists the fields and tags available in a statistics measurement.

    Example

    {
  "measurement": "Flows"
}

    Relations

    Retrieves information about the content of the stats measurement.

    Attributes

    Contains the list of fields. You cannot group by these fields.
    Name of the measurement.
    Default value:
    "Flows"
    Type: []string
    Contains the list of tags. You can group by these tags.

    StatsQuery

    Retrieves time-series data stored by the Microsegmentation Console. Allows different types of queries that are all protected within the namespace of the user.

    Example

    {
  "descending": false,
  "limit": -1,
  "measurement": "Flows",
  "offset": -1
}

    Relations

    Sends a query on statistical data.
    Parameters:
    Mandatory Parameters

    Attributes

    Type: boolean
    If set, the results will be order by time from the most recent to the oldest.
    Type: []string
    List of fields to extract. If you don’t pass anything, all available fields will be returned. It is also possible to use a function like sum(value).
    Type: string
    Apply a filter to the query.
    Type: []string
    Group results by the provided values. Note that not all fields can be used to group the results.
    Type: integer
    Limits the number of results. -1 means no limit.
    Default value:
    -1
    Name of the measurement.
    Default value:
    "Flows"
    Type: integer
    Offsets the results. -1 means no offset.
    Default value:
    -1
    Contains the result of the query.

    TimeSeriesQueryResults

    Represent the results of a stats query.

    Attributes

    List of rows.

    TimeSeriesRow

    Represents a time-series row.

    Attributes

    Type: []string
    Columns of the row.
    Type: string
    Name of the row.
    List of tags.
    List of tags.

    Recommended For You

    Recommended Videos

    Recommended videos not found.

    © 2022 Palo Alto Networks, Inc. All rights reserved.

    Techdocs Logo