Configuration Update Application Map Profiles

Configuration Update Application Map Profiles

Update Application Map IP and port mappings for select applications to ensure they are consistent with the current authoritative mappings maintained by the application provider AND push the resulting changes to the Edges assigned the updated Application Maps immediately. On success, returns an object identifying the profiles and enterprises updated.

Privileges required:

UPDATE SOFTWARE_PACKAGE

Request
URI
POST
https://{api_host}/portal/rest/configuration/updateApplicationMapProfiles
COPY
Request Body

Show optional properties

{
    "id": 0
}
{
    "id": 0,
    "checkOnly": false,
    "updateContent": false
}
integer
id
Required

The id of the Application Map to be updated

boolean
checkOnly
Optional

When true, causes the server to return the list of profiles that would be updated, without actually executing the update or configuration push. This allows users to perform a "dry run" and assess the impact of the change in a risk-off manner.

boolean
updateContent
Optional
Constraints: default: true

When false, the Application Map is simply "pushed" in its current state to the Edges to which it is assigned (the server skips performing a "refresh").

Responses
200

Request was successfully processed

Returns configuration_update_application_map_profiles_result of type(s) application/json 
{
    "profiles": [
        {
            "id": 0,
            "name": "string",
            "logicalId": "string",
            "metaDataVersion": "string",
            "data": "string",
            "moduleId": 0,
            "moduleVersion": "string"
        }
    ],
    "enterprises": [
        {
            "id": 0,
            "name": "string",
            "logicalId": "string"
        }
    ]
}
array of object
profiles
Optional

profiles

array of object
enterprises
Optional

enterprises


400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"id:"integer"}' https://{api_host}/portal/rest/configuration/updateApplicationMapProfiles
On This Page
All Operations
POST
Configuration Clone Enterprise Template
POST
Configuration Delete Configuration
POST
Configuration Get Configuration
POST
Configuration Get Identifiable Applications
POST
Configuration Get Routable Applications
POST
Configuration Update Application Map Content
POST
Configuration Update Application Map Profiles