Module Settings

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.

GEThttps://app.configure8.io/public/v1/module-settings

Query parameters

Response

Body

id*string

The unique identifier of the module setting

serviceId*string

The unique identifier of the service associated with the module setting

credentialId*string

The unique identifier of the credential associated with the module setting

providerName*enum

The name of the provider

GitHubGitLabAzure DevOpsBitbucketCircleCIDatadogEmbeddedViewJenkinsJiraNewRelicOpsGeniePagerDutyScorecardsSonarCloudSplunk

providerType*enum

The type of the provider

REPOSCICDOTHERISSUE_TRACKINGOMSCODE_INSPECTION

orgId*string

The unique identifier of the organization associated with the module setting

title*string

The title of the module setting

uiPluginName*enum

The name of the UI plugin associated with the module setting

github_actionsgithub_activitygitlab_pipelinesgitlab_activityazure_devops_activityazure_devops_pipelinesbitbucket_pipelinesbitbucket_activitycircle_cidatadog_embedded_dashboarddatadog_embedded_graphdatadog_monitordatadog_sloembedded_viewjenkinsjira_activitynew_relic_chartopsgenie_oncallpagerduty_oncallscorecardssonarcloud_repo_profileaws_security_hubsplunk_oncall

configuration*array of ModuleSettingAspectDto (object)

An array of configuration aspects for the module setting

layout*all of

The layout of the module setting

status*enum

The status of the module setting

ACTIVECREDENTIAL_DISABLEDCREDENTIAL_BROKEN

createdBy*string

The unique identifier of the user who created the module setting

lastChangedBy*string

The unique identifier of the user who last changed the module setting

createDateTime*string (date-time)

The date and time when the module setting was created

lastChangedDateTime*string (date-time)

The date and time when the module setting was last changed

state*array of ModuleSettingStateDto (object)

An array of state information associated with the module setting

Request

const response = await fetch('https://app.configure8.io/public/v1/module-settings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "serviceId": "text",
    "credentialId": "text",
    "providerName": "GitHub",
    "providerType": "REPOS",
    "orgId": "text",
    "title": "text",
    "uiPluginName": "github_actions",
    "configuration": [
      {
        "name": "text"
      }
    ],
    "layout": {
      "x": 0,
      "y": 0,
      "w": 0,
      "h": 0,
      "minW": 0,
      "maxW": 0,
      "minH": 0,
      "maxH": 0,
      "static": false,
      "isResizable": false,
      "isBounded": false
    },
    "status": "ACTIVE",
    "createdBy": "text",
    "lastChangedBy": "text",
    "createDateTime": "2024-12-21T12:33:25.450Z",
    "lastChangedDateTime": "2024-12-21T12:33:25.450Z",
    "state": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  }
]

Create a module settings object.

POSThttps://app.configure8.io/public/v1/module-settings

Body

Module settings object to be saved.

serviceId*string

Existing Service identifier

credentialIdstring

Existing Credential identifier

providerName*enum

Provider name

GitHubGitLabAzure DevOpsBitbucketCircleCIDatadogEmbeddedViewJenkinsJiraNewRelicOpsGeniePagerDutyScorecardsSonarCloudSplunk

providerType*enum

Provider type

REPOSCICDOTHERISSUE_TRACKINGOMSCODE_INSPECTION

titlestring

Module title

uiPluginNameenum

Plugin name

configuration*array of ModuleSettingAspectDto (object)

Array of configuration aspects

layoutall of

The layout of the module setting

statearray of ModuleSettingStateDto (object)

Array of state information

status*enum

Status of the module setting

ACTIVECREDENTIAL_DISABLEDCREDENTIAL_BROKEN

Response

Body

id*string

The unique identifier of the module setting

serviceId*string

The unique identifier of the service associated with the module setting

credentialId*string

The unique identifier of the credential associated with the module setting

providerName*enum

The name of the provider

GitHubGitLabAzure DevOpsBitbucketCircleCIDatadogEmbeddedViewJenkinsJiraNewRelicOpsGeniePagerDutyScorecardsSonarCloudSplunk

providerType*enum

The type of the provider

REPOSCICDOTHERISSUE_TRACKINGOMSCODE_INSPECTION

orgId*string

The unique identifier of the organization associated with the module setting

title*string

The title of the module setting

uiPluginName*enum

The name of the UI plugin associated with the module setting

configuration*array of ModuleSettingAspectDto (object)

An array of configuration aspects for the module setting

layout*all of

The layout of the module setting

status*enum

The status of the module setting

ACTIVECREDENTIAL_DISABLEDCREDENTIAL_BROKEN

createdBy*string

The unique identifier of the user who created the module setting

lastChangedBy*string

The unique identifier of the user who last changed the module setting

createDateTime*string (date-time)

The date and time when the module setting was created

lastChangedDateTime*string (date-time)

The date and time when the module setting was last changed

state*array of ModuleSettingStateDto (object)

An array of state information associated with the module setting

Request

const response = await fetch('https://app.configure8.io/public/v1/module-settings', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "serviceId": "text",
      "providerName": "GitHub",
      "providerType": "REPOS",
      "configuration": [
        {
          "name": "text"
        }
      ],
      "status": "ACTIVE"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "serviceId": "text",
  "credentialId": "text",
  "providerName": "GitHub",
  "providerType": "REPOS",
  "orgId": "text",
  "title": "text",
  "uiPluginName": "github_actions",
  "configuration": [
    {
      "name": "text"
    }
  ],
  "layout": {
    "x": 0,
    "y": 0,
    "w": 0,
    "h": 0,
    "minW": 0,
    "maxW": 0,
    "minH": 0,
    "maxH": 0,
    "static": false,
    "isResizable": false,
    "isBounded": false
  },
  "status": "ACTIVE",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-12-21T12:33:25.450Z",
  "lastChangedDateTime": "2024-12-21T12:33:25.450Z",
  "state": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Get a module setting by id.

GEThttps://app.configure8.io/public/v1/module-settings/{id}

Path parameters

id*string

Id for given module setting.

Response

Body

id*string

The unique identifier of the module setting

serviceId*string

The unique identifier of the service associated with the module setting

credentialId*string

The unique identifier of the credential associated with the module setting

providerName*enum

The name of the provider

GitHubGitLabAzure DevOpsBitbucketCircleCIDatadogEmbeddedViewJenkinsJiraNewRelicOpsGeniePagerDutyScorecardsSonarCloudSplunk

providerType*enum

The type of the provider

REPOSCICDOTHERISSUE_TRACKINGOMSCODE_INSPECTION

orgId*string

The unique identifier of the organization associated with the module setting

title*string

The title of the module setting

uiPluginName*enum

The name of the UI plugin associated with the module setting

configuration*array of ModuleSettingAspectDto (object)

An array of configuration aspects for the module setting

layout*all of

The layout of the module setting

status*enum

The status of the module setting

ACTIVECREDENTIAL_DISABLEDCREDENTIAL_BROKEN

createdBy*string

The unique identifier of the user who created the module setting

lastChangedBy*string

The unique identifier of the user who last changed the module setting

createDateTime*string (date-time)

The date and time when the module setting was created

lastChangedDateTime*string (date-time)

The date and time when the module setting was last changed

state*array of ModuleSettingStateDto (object)

An array of state information associated with the module setting

Request

const response = await fetch('https://app.configure8.io/public/v1/module-settings/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "serviceId": "text",
  "credentialId": "text",
  "providerName": "GitHub",
  "providerType": "REPOS",
  "orgId": "text",
  "title": "text",
  "uiPluginName": "github_actions",
  "configuration": [
    {
      "name": "text"
    }
  ],
  "layout": {
    "x": 0,
    "y": 0,
    "w": 0,
    "h": 0,
    "minW": 0,
    "maxW": 0,
    "minH": 0,
    "maxH": 0,
    "static": false,
    "isResizable": false,
    "isBounded": false
  },
  "status": "ACTIVE",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-12-21T12:33:25.450Z",
  "lastChangedDateTime": "2024-12-21T12:33:25.450Z",
  "state": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

PreviousCredentials NextPublic API Query Builder

Last updated 4 months ago

[ { "id": "text", "serviceId": "text", "credentialId": "text", "providerName": "GitHub", "providerType": "REPOS", "orgId": "text", "title": "text", "uiPluginName": "github_actions", "configuration": [ { "name": "text" } ], "layout": { "x": 0, "y": 0, "w": 0, "h": 0, "minW": 0, "maxW": 0, "minH": 0, "maxH": 0, "static": false, "isResizable": false, "isBounded": false }, "status": "ACTIVE", "createdBy": "text", "lastChangedBy": "text", "createDateTime": "2024-12-21T12:33:25.450Z", "lastChangedDateTime": "2024-12-21T12:33:25.450Z", "state": [ { "key": "text", "value": "text" } ] } ]

{ "id": "text", "serviceId": "text", "credentialId": "text", "providerName": "GitHub", "providerType": "REPOS", "orgId": "text", "title": "text", "uiPluginName": "github_actions", "configuration": [ { "name": "text" } ], "layout": { "x": 0, "y": 0, "w": 0, "h": 0, "minW": 0, "maxW": 0, "minH": 0, "maxH": 0, "static": false, "isResizable": false, "isBounded": false }, "status": "ACTIVE", "createdBy": "text", "lastChangedBy": "text", "createDateTime": "2024-12-21T12:33:25.450Z", "lastChangedDateTime": "2024-12-21T12:33:25.450Z", "state": [ { "key": "text", "value": "text" } ] }

const response = await fetch('https://app.configure8.io/public/v1/module-settings', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "serviceId": "text", "providerName": "GitHub", "providerType": "REPOS", "configuration": [ { "name": "text" } ], "status": "ACTIVE" }), }); const data = await response.json();