2021.1 (latest)

2021.1.2 (latest)
2020.2.7
2020.1.15
2019.3.19
2019.2.25
2019.1.23
2018.3.27
Cloud

API REFERENCE
USER
- Automation Gateway
- Automation Platform
ADMIN
DEVELOPER
- Automation Platform
- Policy Manager
PRODUCT NOTICES

API Reference

adapter-automation_gateway
adapter-email
adapter-nso
app-admin_essentials
app-ag_manager
app-automation_catalog
app-automation_studio
app-configuration_manager
app-form_builder
app-json_forms
app-jst
app-mop
app-nso_manager
app-operations_manager
app-service_catalog
app-service_management
app-template_builder
app-workflow_builder
app-workflow_engine
pronghorn-core
search
tags

Documentation
API Reference
pronghorn-core

Help us improve by sending feedback...

Cancel Send

On this page:

pronghorn-core

Show Deprecated Endpoints

checkIndexes

Check the status of a collection's indexes in Mongo

GET /indexes/:collection/status

Check the status of pre-defined indexes for a specific collection.
createAccount

Create a new account for Local AAA instance.

POST /user-management/accounts

Create a new account for Local AAA instance in IAP.
createAdapter

Create a new adapter.

POST /adapters

Create a new adapter in IAP.
createGroup

Create a new group for Local AAA instance.

POST /user-management/groups

Create a new group for Local AAA instance in IAP.
createIndexes

Create a collection's indexes in Mongo

POST /indexes/:collection

Create all pre-defined indexes for a specific collection.
createIntegration

Create a new integration.

POST /integrations

Create a new integration in IAP.
createIntegrationModel

Create a new integration model.

POST /integration-models

Create a new integration model in IAP.
createProfile

Creates a new profile

POST /profiles

Create a new profile in IAP.
createRepositoryConfig

Create repository configuration

POST /prebuilts-repository/configs

Create a new repository configuration
deleteAccount

Delete an account from Local AAA instance.

DELETE /user-management/accounts/:accountId

Delete an account from Local AAA instance in IAP.
deleteAdapter

Delete an adapter.

DELETE /adapters/:name

Delete an adapter from IAP.
deleteGroup

Delete a group from Local AAA instance.

DELETE /user-management/groups/:groupId

Delete a group from Local AAA instance in IAP.
deleteIntegration

Delete an integration.

DELETE /integrations/:name

Delete an integration from IAP.
deleteIntegrationModel

Delete an integration model.

DELETE /integration-models/:name

Delete an integration model from IAP.
deleteProfile

Delete a profile.

DELETE /profiles/:id

Delete a profile from IAP.
deleteRepositoryConfig

Delete repository configuration

DELETE /prebuilts-repository/configs/:name

Delete an existing repository configuration
exportIntegrationModel

Export an integration model.

GET /integration-models/:name/export

Export an integration model's open API spec.
exportPrebuilt

Export a prebuilt

GET /prebuilts/:id/export

Export a prebuilt from IAP.
getAccount

Get an account from Local AAA instance.

GET /user-management/accounts/:accountId

Get an account from Local AAA instance in IAP.
getAccounts

Get all accounts from Local AAA instance.

GET /user-management/accounts

Get all accounts from Local AAA instance in IAP.
getAdapter

Get a single adapter.

GET /adapters/:name

Get a single adapter in IAP.
getAdapterChangelogs

Get the list of changelogs.

GET /adapters/:name/changelogs

Get the list of changelogs for a specific adapter.
getAdapterHealth

Get the health of a single adapter.

GET /health/adapters/:name

Get the health of a single adapter in IAP.
getAdapterModelTypes

Get the list of available adapter model types.

GET /adapter-models/types

Get the list of available adapter model types in the current IAP.
getAdapters

Get all adapters.

GET /adapters

Get all adapters in IAP.
getAdapterSchema

Get the adapter schema.

GET /schema/adapters/:name

Get the adapter schema.
getAdaptersHealth

Get the health of all the adapters.

GET /health/adapters

Get the health of all the adapters in IAP.
getApplication

Get a single application.

GET /applications/:name

Get a single application in IAP.
getApplicationChangelogs

Get the list of changelogs.

GET /applications/:name/changelogs

Get the list of changelogs for a specific application.
getApplicationHealth

Get the health of a single application.

GET /health/applications/:name

Get the health of a single application in IAP.
getApplications

Get all applications.

GET /applications

Get all applications in IAP.
getApplicationSchema

Get the application schema.

GET /schema/applications/:name

Get the application schema.
getApplicationsHealth

Get the health of all the applications.

GET /health/applications

Get the health of all the applications in IAP.
getAssignableRoles

Get all assignable roles.

GET /user-management/roles

Get all assignable roles based on permissions in IAP.
getGroup

Get a group from Local AAA instance.

GET /user-management/groups/:groupId

Get a group from Local AAA instance in IAP.
getGroups

Get all groups from Local AAA instance.

GET /user-management/groups

Get all groups from Local AAA instance in IAP.
getIndexes

Get all pre-defined indexes.

GET /indexes

Get all pre-defined indexes to be used in Mongo.
getIntegration

Get a single integration.

GET /integrations/:name

Get a single integration in IAP.
getIntegrationModel

Get a specific integration model.

GET /integration-models/:name

Get a specific integration model in IAP.
getIntegrationModels

Get all integration models.

GET /integration-models

Get all the integration models in IAP.
getIntegrations

Get all integrations.

GET /integrations

Get all integrations in IAP.
getIntegrationSchema

Get the integration schema.

GET /schema/integrations/:name

Get the integration schema.
getPrebuilt

Get a single prebuilt.

GET /prebuilts/:id

Get a single prebuilt in IAP.
getPrebuilts

Get all the prebuilts.

GET /prebuilts

Get all the prebuilts in IAP.
getProfile

Get a single profile.

GET /profiles/:id

Get a single profile in the current IAP.
getProfiles

Get all profiles.

GET /profiles

Get all the profiles in IAP.
getProfileSchema

Get the profile schema.

GET /schema/profiles

Get the profile schema.
getPrometheusMetrics

Get prometheus metrics.

GET /prometheus_metrics

Builds and returns all prometheus metrics.
getRepositoryConfigs

Get Repository Configurations

GET /prebuilts-repository/configs

Get all the Prebuilt Repository configurations
getRepositoryPrebuilts

Get all prebuilts

GET /prebuilts-repository

Get all prebuilts from a repository.
getServerHealth

Get the health of the server.

GET /health/server

Get the health of the server.
getSystemHealth

Get the health of the system.

GET /health/system

Get the health of the system.
importPrebuilt

Import a prebuilt.

POST /prebuilts/import

Import a prebuilt into IAP.
removePrebuilt

Remove a prebuilt.

DELETE /prebuilts/:id

Remove a prebuilt from IAP.
restartAdapter

Restart an adapter.

PUT /adapters/:name/restart

Restart an adapter in IAP.
restartApplication

Restart an application.

PUT /applications/:name/restart

Restart an application in IAP.
setAccountGroups

Set the groups for an account.

PUT /user-management/accounts/:accountId/groups

Set the groups for an account in a Local AAA instance.
setAccountPassword

Change the password for an account.

PUT /user-management/accounts/:accountId/password

Change the password for an account in the Local AAA instance.
setGroupRoles

Set the roles for a group.

PUT /user-management/groups/:groupId/roles

Set the roles for a group in a Local AAA instance.
startAdapter

Start an adapter.

PUT /adapters/:name/start

Start an adapter in IAP.
startApplication

Start an application.

PUT /applications/:name/start

Start an application in IAP.
stopAdapter

Stop an adapter.

PUT /adapters/:name/stop

Stop an adapter in IAP.
stopApplication

Stop an application.

PUT /applications/:name/stop

Stop an application in IAP.
switchActiveProfile

Switch the active profile.

PUT /profiles/:id/active

Switch the active profile in the current IAP.
updateAdapter

Update an adapter.

PUT /adapters/:name

Update an adapter in IAP.
updateAdapterLogging

Update the log levels.

PUT /adapters/:name/loglevel

Update the log levels for an adapter.
updateAdapterProperties

Update the properties of an adapter.

PUT /adapters/:name/properties

Update the properties of an adapter in IAP.
updateApplication

Update an application.

PUT /applications/:name

Update an application in IAP.
updateApplicationLogging

Update the log levels.

PUT /applications/:name/loglevel

Update the log levels for an application.
updateApplicationProperties

Update the properties of an application.

PUT /applications/:name/properties

Update the properties of an application in IAP.
updateIntegration

Update an integration.

PUT /integrations/:name

Update an integration in IAP.
updateIntegrationModel

Update an integration model.

PUT /integration-models

Update an integration model in IAP.
updateIntegrationProperties

Update the properties of an integration.

PUT /integrations/:name/properties

Update the properties of an integration in IAP.
updatePrebuilt

Update a prebuilt

PUT /prebuilts/:id

Update a prebuilt in IAP.
updateProfile

Updates a profile.

PUT /profiles/:id

Update a profile in IAP.
validateIntegrationModel

Validate an integration model.

PUT /integration-models/validation

Validate an integration model.
validatePrebuilt

Validate the data structure of a prebuilt.

PUT /prebuilts/import/validation

Validate the data structure of a prebuilt in IAP.

FAQs

|

Service Desk

|

Developer Hub

|

Itential Academy

|

On-Demand Webinars

|

Videos

Sign up to receive our newsletter of automation insights straight to your inbox:

© 2021 Itential for Developers

|

Privacy Policy

|

Cookie Policy

|

Terms of Use

|

EULA