Methods

On this page:

Pronghorn Core

Deprecations in Pronghorn Core

Scheduled removals are listed in the table below.

Item Description Deprecation Release Scheduled Removal Release Replacement
/isAlive Gets the status of the server. 2018.3 2021.1 /status
DELETE /config/profile/delete/:id Deletes a profile. 2020.2 2021.2 DELETE /profiles/:id
DELETE /config/services/delete/:name Deletes a service config from the system. 2020.2 2021.2 DELETE /adapters/:name
DELETE /providers/:id Deletes an adapter from the system. 2020.2  2021.2 DELETE /adapters/:name
GET /config/active_services Get all the active services running on the system. 2020.2  2021.2 GET /adapters or /applications
GET /config/active_adapters Get all the active adapters running on the system. 2020.2  2021.2 GET /adapters
GET /config/profiles Get all profiles in IAP. 2020.2 2021.2 GET /profiles
GET /config/profiles/sync Determines if active profile is in sync with system. 2020.2 2021.2 GET /profiles
GET /config/property Get the properties of an active profile. 2020.2 2021.2 GET /profiles
GET /config/property/id/:id Get the properties of a profile. 2020.2 2021.2 GET /profiles/:id
GET /config/property/schema Get the properties schema. 2020.2 2021.2 GET /schema/profiles
GET /config/services Get all the service configs on a system. 2020.2 2021.2 GET /adapters or /applications
GET /config/services/schema Gets the service config schema. 2020.2  2021.2 GET /schema/adapters/:name or /schema/applications/:name
GET /config/services/sync Determines which services are in sync with the system. 2020.2  2021.2 GET /adapters or /applications
GET /health/system Gets the health of the system. 2020.2 2021.2 GET /health/system
GET /health/server Gets the health of the server. 2020.2 2021.2 GET /health/server
GET /health/modules Gets the health of each service. 2020.2 2021.2 GET /health/adapters or /health/applications
GET /health/module/:module Gets the health of one service. 2020.2 2021.2 GET /health/adapters/:name or health/applications/:name
GET /modules/stop/:module Stops a running service. 2020.2 2021.2 PUT /adapters/:name/stop or /applications/:name/stop
GET /modules/start/:module Starts a service. 2020.2 2021.2 PUT /adapters/:name/start or /applications/:name/start
GET /modules/restart/:module Restart a running service. 2020.2 2021.2 PUT /adapters/:name/restart or /applications/:name/restart
GET /providers Get all the adapters on the system. 2020.2  2021.2 GET /adapters
GET /providers/:id Gets an adapter by id. 2020.2 2021.2 GET /adapters/:name
GET /providers/:id/schema Gets the specific schema for that particular adapter type. 2020.2 2021.2 GET /schema/adapters/:name
GET /providers/schema Gets the schema for adapters. 2020.2  2021.2 GET /schema/adapters/:name
POST /config/profile/add Creates a new profile. 2020.2 2021.2 POST /profiles
POST /config/profiles/change Changes the active profile. 2020.2 2021.2 PUT /profiles/:id/active
POST /config/property/new Adds a property to a profile. 2020.2 2021.2 PUT /profiles/:id
POST /config/property/update Updates a profile property. 2020.2 2021.2 PUT /profiles/:id
POST /config/services/create Creates a new service config. 2020.2 2021.2 POST /adapters
POST /config/services/save Updates an existing service config. 2020.2  2021.2 PUT /adapters/:name or /applications/:name
POST /modules/load Creates a new app during runtime. 2020.2 2021.2 None
POST /modules/setLogging Set the log levels for a service during runtime. 2020.2 2021.2 PUT /adapters/:name/loglevel or /applications/:name/loglevel
POST /providers/schema/update Gets the current schema for each type of adapter. 2020.2 2021.2 GET /schema/adapters/:name
POST /appUpdate/changeLog/ Gets the changelog for a service. 2020.2 2021.2 GET /adapters/:name/changelogs /application/:name/changelogs
PUT /providers/:id Creates or updates an adapter. 2020.2 2021.2 PUT /adapters/:name

$VAULT Encryption Replaces $ENC Encryption

The $ENC encryption used within service configs, profiles, and the properties.json is now deprecated. The replacement is $VAULT_ followed by the path used in Hashicorp Vault for encryption and decryption. Support for $ENC will be removed in the 2021.2 release, and any remaining $ENC values will no longer function after its removal.