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

    Integration resources

    integration/app

    App

    Represents an application that can be installed.

    Example

    {
  "beta": false,
  "name": "the name"
}

    Relations

    Retrieves the list of apps.
    Parameters:
    • name (string): internal parameter.
    • q (string): Filtering query. Consequent q parameters will form an or.

    Attributes

    Type: boolean
    Set to true to indicate that the app is in a beta version.
    Type: string
    Category ID of the app.
    Type: string
    Description of the object.
    Type: string
    Contains a base64-encoded image for the app.
    Type: string
    Represents the latest version available of the app.
    Type: string
    Contains a more detailed description of the app.
    Type: string
    Name of the entity.
    Type: []uistep
    List of steps that contain parameters.
    Type: string
    Represents the title of the app.

    Category

    Allows you to categorize services.

    Example

    {
  "name": "the name"
}

    Attributes

    Type: string
    Identifier of the object.
    Type: string
    Description of the object.
    Type: string
    Name of the entity.

    InstalledApp

    Represents an installed application.

    Example

    {
  "additionalConfiguration": false,
  "checkPublicEndpoint": false,
  "name": "the name",
  "protected": false,
  "status": "Unknown"
}

    Relations

    Retrieves the list of installed apps.
    Parameters:
    • tag (string): List of tags to filter on. This parameter is deprecated.
    • q (string): Filtering query. Consequent q parameters will form an or.
    Installs a new app.
    Deletes the application with the given ID.
    Parameters:
    • q (string): Filtering query. Consequent q parameters will form an or.
    Retrieves the application with the given ID.
    Updates the application with the given ID.
    Returns the logs for an application.

    Attributes

    Type: string
    Identifier of the object.
    Type: boolean
    Additional configuration of the app is needed by the app itself.
    Stores additional information about an entity.
    Type: []string
    List of tags attached to an entity.
    Type: string
    The category ID of the application.
    Type: boolean
    If true, will look for the public endpoints and store them as annotations in the installed app.
    Type: time
    Creation date of the object.
    Type: string
    Version of the installed application.
    Adds a button in the UI.
    Type: string
    Name of the entity.
    Type: string
    Namespace tag attached to an entity.
    Type: []string
    Contains the list of normalized tags of the entities.
    Contains the computed parameters to start the application.
    Type: boolean
    Defines if the object is protected.
    Status of the application.
    Default value:
    "Unknown"
    Type: string
    Reason for the status of the application.
    Type: time
    Last update date of the object.

    Log

    Retrieves the logs of a deployed application.

    Relations

    Returns the logs for an application.

    Attributes

    Contains all log data.

    integration/automation

    Automation

    Allows you to define some JavaScript code and specify the conditions under which it should be executed.

    Example

    {
  "condition": "function when(m, params) { return { continue: true }}",
  "disabled": false,
  "immediateExecution": false,
  "name": "the name",
  "protected": false,
  "tokenRenew": false,
  "trigger": "Time"
}

    Relations

    Retrieves the list of automations.
    Parameters:
    • q (string): Filtering query. Consequent q parameters will form an or.
    Creates a new Automation.
    Deletes the automation with the given ID.
    Parameters:
    • q (string): Filtering query. Consequent q parameters will form an or.
    Retrieves the automation with the given ID.
    Updates the automation with the given ID.
    Allows a system to trigger the automation if its trigger property is set to RemoteCall.
    Allows a system to trigger the automation if its trigger property is set to RemoteCall.

    Attributes

    Type: string
    Identifier of the object.
    Type: []string
    Contains the code that will be executed if the condition is met.
    Stores additional information about an entity.
    Type: []string
    List of tags attached to an entity.
    Type: string
    Condition contains the code that will be executed to decide if any action(s) should be executed. Providing a condition for an automation with a "Webhook" trigger type will have no impact as the condition will not be evaluated. If no condition is defined, then the automation action(s) will be executed; this behaves akin to a condition that always succeeds.
    Type: time
    Creation date of the object.
    Type: string
    Description of the object.
    Type: boolean
    Defines if the property is disabled.
    Declares which operations are allowed on which identities.
    Type: []string
    Contains the error of the last run.
    Contains the identity and operation an event must have to trigger the automation.
    Type: boolean
    If set and the trigger is of type Time, the automation will be run at create or update before being scheduled.
    Type: time
    The last successful execution tine.
    Type: string
    Name of the entity.
    Type: string
    Namespace tag attached to an entity.
    Type: []string
    Contains the list of normalized tags of the entities.
    Contains the computed parameters.
    Type: boolean
    Defines if the object is protected.
    Type: string
    Specifies when to run the automation. Must be in valid CRON format. This only applies if the trigger is set to Time.
    Type: string
    Signature to validate the authenticity of the object.
    Type: string
    Contains the standard output of the last run.
    Type: string
    Holds the unique access token used as a password to trigger the authentication. It will be visible only after creation.
    Type: boolean
    If set to true a new token will be issued and the previous one invalidated.
    Controls when the automation should be triggered.
    Default value:
    "Time"
    Type: time
    Last update date of the object.

    AutomationTemplate

    Templates that can be used in automations.

    Example

    {
  "kind": "Condition",
  "name": "the name"
}

    Relations

    Retrieves the list of automation templates.
    Retrieves the template with the given ID.

    Attributes

    Type: string
    Description of the object.
    Contains the entitlements needed for executing the function.
    Type: string
    Function contains the code.
    Type: string
    Contains the unique identifier key for the template.
    Represents the kind of template.
    Default value:
    "Condition"
    Type: string
    Name of the entity.
    Contains the computed parameters.
    Type: []uistep
    Contains all the steps with parameters.

    Trigger

    Can be used to remotely trigger an automation.

    Relations

    Allows a system to trigger the automation if its trigger property is set to RemoteCall.
    Allows a system to trigger the automation if its trigger property is set to RemoteCall.

    Recommended For You

    Recommended Videos

    Recommended videos not found.

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

    Techdocs Logo