Skip to content

CIRA Configurations

Developer mode (Vault and DB disabled)

In developer mode, all profiles and configurations are written to the file private/data.json.

Prod mode (With Vault and Database enabled)

In production mode, all profiles and CIRA configurations are written to the database, and secrets are stored in Vault.

The inputs below for both CIRA Config and AMT Profile creation will work in either Developer or Prod mode.

Create a CIRA Configuration

  • Endpoint: /api/v1/admin/ciraconfigs/
  • Method Type: POST
  • Headers: X-RPS-API-Key

proxyDetails is an optional field. 

{
    "payload": {
        "configName": "config1",
        "mpsServerAddress": "localhost",
        "mpsPort": 4433,
        "username": "admin",
        "password": "P@ssw0rd",
        "commonName": "localhost",
        "serverAddressFormat": 201,
        "mpsRootCertificate": "",
        "proxyDetails": "", 
        "authMethod": 2
    }
}

Output:

Success

CIRA Config config1 successfully inserted

Failure

CIRA Config insertion failed for config1. CIRA Config already exists.

Get all CIRA configurations

  • Endpoint: /api/v1/admin/ciraconfigs/
  • Method Type: GET
  • Headers: X-RPS-API-Key

Sample Response:

[
    {
        "ConfigName": "config1",
        "MPSServerAddress": "13.64.233.163",
        "MPSPort": 4433,
        "Username": "admin",
        "Password": null,
        "CommonName": "13.64.233.163",
        "ServerAddressFormat": 201,
        "AuthMethod": 2,
        "MPSRootCertificate": "null",
        "ProxyDetails": "null"
    },
    {
        "ConfigName": "config2",
        "MPSServerAddress": "localhost",
        "MPSPort": 4433,
        "Username": "admin",
        "Password": null,
        "CommonName": "localhost",
        "ServerAddressFormat": 201,
        "AuthMethod": 2,
        "MPSRootCertificate": "",
        "ProxyDetails": ""
    }
]

Get a CIRA configuration

  • Endpoint: /api/v1/admin/ciraconfigs/{ciraconfigName}
  • Method Type: GET
  • Headers: X-RPS-API-Key

Sample Response:

{
    "ConfigName": "config1",
    "MPSServerAddress": "localhost",
    "MPSPort": 4433,
    "Username": "admin",
    "Password": null,
    "CommonName": "localhost",
    "ServerAddressFormat": 201,
    "AuthMethod": 2,
    "MPSRootCertificate": "",
    "ProxyDetails": ""
}

Edit a CIRA Configuration

  • Endpoint: /api/v1/admin/ciraconfigs/edit
  • Method Type: POST
  • Headers: X-RPS-API-Key

ONLY proxyDetails is optional. 

{
    "payload": {
        "configName": "config1",
        "mpsServerAddress": "localhost",
        "mpsPort": 4434,
        "username": "admin",
        "password": "P@ssw0rd",
        "commonName": "localhost",
        "serverAddressFormat": 201,
        "mpsRootCertificate": "",
        "proxyDetails": "", 
        "authMethod": 2
    }
}

Output:

Success

CIRA Config config1 successfully inserted

Failure

CIRA Config config11 not found

Delete a CIRA configuration

  • Endpoint: /api/v1/admin/ciraconfigs/{ciraconfigName}
  • Method Type: DELETE
  • Headers: X-RPS-API-Key
Success

CIRA Config config1 successfully deleted

Failure

Deletion failed for CIRA Config: config1. Profile associated with this Config.

Return to RPS Methods