Module Settings

• Get a list of filtered module settings

• Create a new module setting

• Get a single module setting

UI plugin names possible values:

"github_actions", "github_activity", "gitlab_pipelines", "gitlab_activity", "azure_devops_activity", "azure_devops_pipelines", "bitbucket_pipelines", "bitbucket_activity", "circle_ci", "datadog_embedded_dashboard", "datadog_embedded_graph", "datadog_monitor", "datadog_slo", "embedded_view", "jenkins", "jira_activity", "new_relic_chart", "opsgenie_oncall", "pagerduty_oncall", "scorecards", "sonarcloud_repo_profile"

Provider type possible values:

"REPOS", "CICD", "OTHER", "ISSUE_TRACKING", "OMS", "CODE_INSPECTION"

Provider name possible values:

"GitHub", "GitLab", "Azure DevOps", "Bitbucket", "CircleCI", "Datadog", "EmbeddedView", "Jenkins", "Jira", "NewRelic", "OpsGenie", "PagerDuty", "Scorecards", "SonarCloud"

GET a list of all module settings.

get

/public/v1/module-settings

Query parameters

serviceIdstring

Service identifier

credentialIdstring

Credential identifier

providerTypestring · enum

Provider type

Options: CLOUD, REPOS, CICD, OTHER, ISSUE_TRACKING, OMS, CODE_INSPECTION

providerNamestring · enum

Provider name

Options: AWS, GCP, GitHub, GitLab, Azure DevOps, AZURE, Bitbucket, CircleCI, CustomPlugin, Datadog, EmbeddedView, HttpClient, Jenkins, Jira , NewRelic, OpsGenie, PagerDuty, Scorecards, SonarCloud, Splunk

filterany

Module Setting Filter.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.configure8.io/public/v1/module-settings'

200

401

403

404

200

[
  {
    "id": "text",
    "serviceId": "text",
    "credentialId": "text",
    "orgId": "text",
    "title": "text",
    "createdBy": "text",
    "lastChangedBy": "text",
    "createDateTime": "2025-02-21T18:21:41.087Z",
    "lastChangedDateTime": "2025-02-21T18:21:41.087Z",
    "providerName": "GitHub",
    "providerType": "REPOS",
    "uiPluginName": "github_actions",
    "status": "ACTIVE",
    "configuration": [
      {
        "name": "text",
        "value": {}
      }
    ],
    "state": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "layout": {
      "x": 1,
      "y": 1,
      "w": 1,
      "h": 1,
      "minW": 1,
      "maxW": 1,
      "minH": 1,
      "maxH": 1,
      "static": true,
      "isResizable": true,
      "isBounded": true
    }
  }
]

Create a module settings object.

post

/public/v1/module-settings

Body

serviceIdstringrequired

Existing Service identifier

credentialIdstring

Existing Credential identifier

titlestring

Module title

providerNamestring · enumrequired

Provider name

Options: GitHub, GitLab, Azure DevOps, Bitbucket, CircleCI, Datadog, EmbeddedView, Jenkins, Jira, NewRelic, OpsGenie, PagerDuty, Scorecards, SonarCloud, Splunk

providerTypestring · enumrequired

Provider type

Options: REPOS, CICD, OTHER, ISSUE_TRACKING, OMS, CODE_INSPECTION

uiPluginNamestring · enum

Plugin name

Options: github_actions, github_activity, gitlab_pipelines, gitlab_activity, azure_devops_activity, azure_devops_pipelines, bitbucket_pipelines, bitbucket_activity, circle_ci, datadog_embedded_dashboard, datadog_embedded_graph, datadog_monitor, datadog_slo, embedded_view, jenkins, jira_activity, new_relic_chart, opsgenie_oncall, pagerduty_oncall, scorecards, sonarcloud_repo_profile, aws_security_hub, splunk_oncall

statusstring · enumrequired

Status of the module setting

Options: ACTIVE, CREDENTIAL_DISABLED, CREDENTIAL_BROKEN

configurationobject[]required

Array of configuration aspects

stateobject[]

Array of state information

layoutall of

The layout of the module setting

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.configure8.io/public/v1/module-settings' \
  --header 'Content-Type: application/json' \
  --data '{"serviceId":"text","providerName":"GitHub","providerType":"REPOS","uiPluginName":"github_actions","status":"ACTIVE","configuration":[{"name":"text","value":{}}],"state":[{"key":"text","value":"text"}],"layout":{"x":1,"y":1,"w":1,"h":1}}'

201

401

403

404

201

{
  "id": "text",
  "serviceId": "text",
  "credentialId": "text",
  "orgId": "text",
  "title": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-21T18:21:41.087Z",
  "lastChangedDateTime": "2025-02-21T18:21:41.087Z",
  "providerName": "GitHub",
  "providerType": "REPOS",
  "uiPluginName": "github_actions",
  "status": "ACTIVE",
  "configuration": [
    {
      "name": "text",
      "value": {}
    }
  ],
  "state": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "layout": {
    "x": 1,
    "y": 1,
    "w": 1,
    "h": 1,
    "minW": 1,
    "maxW": 1,
    "minH": 1,
    "maxH": 1,
    "static": true,
    "isResizable": true,
    "isBounded": true
  }
}

Get a module setting by id.

get

/public/v1/module-settings/{id}

Path parameters

idstringrequired

Id for given module setting.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.configure8.io/public/v1/module-settings/{id}'

200

401

403

404

200

{
  "id": "text",
  "serviceId": "text",
  "credentialId": "text",
  "orgId": "text",
  "title": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-21T18:21:41.087Z",
  "lastChangedDateTime": "2025-02-21T18:21:41.087Z",
  "providerName": "GitHub",
  "providerType": "REPOS",
  "uiPluginName": "github_actions",
  "status": "ACTIVE",
  "configuration": [
    {
      "name": "text",
      "value": {}
    }
  ],
  "state": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "layout": {
    "x": 1,
    "y": 1,
    "w": 1,
    "h": 1,
    "minW": 1,
    "maxW": 1,
    "minH": 1,
    "maxH": 1,
    "static": true,
    "isResizable": true,
    "isBounded": true
  }
}