Jump to

• Request
• Response
• Examples

Policy Cache Diagnostics Refresh

put

/iam/admin/diag/api/v1/policycache/refresh

Refresh server policy cache on all managed servers.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Success

Body ()

Root Schema : PolicyCacheRefreshResults

Type: array

Show Source

• Array of: object PolicyCacheRefreshData

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PolicyCacheRefreshData"
    }
}

Nested Schema : PolicyCacheRefreshData

Type: object

Show Source

• message(optional): string
  Response message
• minorResponseCode(optional): string
  Minor response code
• policyCacheVersion: string
  Policy cache version
• refreshRequestTime: string
  Policy cache refresh request time
• responseCode: string
  Response code
• serverName: string
  Name of server

{
    "type":"object",
    "properties":{
        "serverName":{
            "type":"string",
            "description":"Name of server"
        },
        "policyCacheVersion":{
            "type":"string",
            "description":"Policy cache version"
        },
        "refreshRequestTime":{
            "type":"string",
            "description":"Policy cache refresh request time"
        },
        "responseCode":{
            "type":"string",
            "description":"Response code"
        },
        "minorResponseCode":{
            "type":"string",
            "description":"Minor response code"
        },
        "message":{
            "type":"string",
            "description":"Response message"
        }
    },
    "required":[
        "serverName",
        "policyCacheVersion",
        "refreshRequestTime",
        "responseCode"
    ]
}

401 Response

Not authorized.

422 Response

Unprocessable Entity

Body ()

Root Schema : PolicyCacheRefreshResults

Type: array

Show Source

• Array of: object PolicyCacheRefreshData

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PolicyCacheRefreshData"
    }
}

Nested Schema : PolicyCacheRefreshData

Type: object

Show Source

• message(optional): string
  Response message
• minorResponseCode(optional): string
  Minor response code
• policyCacheVersion: string
  Policy cache version
• refreshRequestTime: string
  Policy cache refresh request time
• responseCode: string
  Response code
• serverName: string
  Name of server

{
    "type":"object",
    "properties":{
        "serverName":{
            "type":"string",
            "description":"Name of server"
        },
        "policyCacheVersion":{
            "type":"string",
            "description":"Policy cache version"
        },
        "refreshRequestTime":{
            "type":"string",
            "description":"Policy cache refresh request time"
        },
        "responseCode":{
            "type":"string",
            "description":"Response code"
        },
        "minorResponseCode":{
            "type":"string",
            "description":"Minor response code"
        },
        "message":{
            "type":"string",
            "description":"Response message"
        }
    },
    "required":[
        "serverName",
        "policyCacheVersion",
        "refreshRequestTime",
        "responseCode"
    ]
}

424 Response

Failed Dependency

Body ()

Root Schema : PolicyCacheRefreshResults

Type: array

Show Source

• Array of: object PolicyCacheRefreshData

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PolicyCacheRefreshData"
    }
}

Nested Schema : PolicyCacheRefreshData

Type: object

Show Source

• message(optional): string
  Response message
• minorResponseCode(optional): string
  Minor response code
• policyCacheVersion: string
  Policy cache version
• refreshRequestTime: string
  Policy cache refresh request time
• responseCode: string
  Response code
• serverName: string
  Name of server

{
    "type":"object",
    "properties":{
        "serverName":{
            "type":"string",
            "description":"Name of server"
        },
        "policyCacheVersion":{
            "type":"string",
            "description":"Policy cache version"
        },
        "refreshRequestTime":{
            "type":"string",
            "description":"Policy cache refresh request time"
        },
        "responseCode":{
            "type":"string",
            "description":"Response code"
        },
        "minorResponseCode":{
            "type":"string",
            "description":"Minor response code"
        },
        "message":{
            "type":"string",
            "description":"Response message"
        }
    },
    "required":[
        "serverName",
        "policyCacheVersion",
        "refreshRequestTime",
        "responseCode"
    ]
}

Default Response

Unexpected error

Back to Top

Examples

This example demonstrates the refresh server policy cache on all managed servers

cURL Example

curl -X PUT http://<host>:<port>/iam/admin/diag/api/v1/policycache/refresh -H 'authorization: Basic d2VibG9naWM6d2VibG9naWMx' -H 'content-type: application/x-www-form-urlencoded' \

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"policyCacheRefreshData": [
{ "serverName": "oam_server1", "policyCacheVersion": "2239", "refreshRequestTime": "2018-05-03T22:59:29.007-07:00", "responseCode": "SUCCESS" } 
]
}

Back to Top