Repository

Create an new repository catalog entity

POSThttps://app.configure8.io/public/v1/catalog/entities/repository

Body

name*string

Name of the entity

descriptionstring

Description of the entity

linksarray of MetadataLinkDto (object)

List of URLs linked to this entity

metaTagsarray of MetadataTagDto (object)

List of metadata tags linked to this entity

permissionsobject

List of permissions linked to this entity. The 'permissions' property is an optional object where the keys can represent either user identifier or team identifier, and the value is array of the permissions ("create", "delete", "execute", "modify", "read") associated with each user or team.

generalAccessarray of enum

Entity visibility control. By default it is set to a default access control on organization level

parentsarray of EntityParentDto (object)

Catalog entity's parents

url*string

The URL of the repository

contributorsarray of RepositoryContributorDto (object)

The list of constributors for this repository

languagesarray of RepositoryLanguageDto (object)

The languages that this repository uses

releaseall of

The latest release of this repository

provider*enum

The provider of this repository

GitHubBitbucketGitLabAzure DevOps

providerResourceKey*string

The key/ID of this repository in the provider

providerAccountId*string

The key/ID of the account that owns this repository

location*string

The full path of the repository

locationGroupstring

The repository project path for nested project providers like GitLab. It can be set to "None" if not applicable.

Response

Body

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecostvulnerability

descriptionstring

Catalog entity description

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

linksarray of MetadataLinkDto (object)

Catalog entity's links

parentsarray of EntityParentDto (object)

Catalog entity's parents

createdBystring

lastChangedBystring

createDateTimestring (date-time)

lastChangedDateTimestring (date-time)

permissionsobject

generalAccessarray of enum

Entity visibility control. By default it is set to a default access control on organization level

url*string

contributors*array of string

languages*array of string

release*RepositoryReleaseDto (object)

provider*string

providerType*string

providerResourceKey*string

providerResourceType*string

providerAccountId*string

location*string

locationGroupstring

detailsobject

Request

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/repository', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "url": "text",
      "provider": "GitHub",
      "providerResourceKey": "text",
      "providerAccountId": "text",
      "location": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to",
      "field": "text"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-11-21T06:26:22.085Z",
  "lastChangedDateTime": "2024-11-21T06:26:22.085Z",
  "generalAccess": [
    "read"
  ],
  "url": "text",
  "contributors": [
    "text"
  ],
  "languages": [
    "text"
  ],
  "release": {
    "name": "text",
    "date": "text",
    "tag": "text",
    "latest": false
  },
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text",
  "location": "text",
  "locationGroup": "text"
}

Update a repository catalog entity

PATCHhttps://app.configure8.io/public/v1/catalog/entities/repository/{id}

Path parameters

id*string

Unique id of catalog entity to update

Body

namestring

Catalog entity name, should be unique, not updatable for discovery created catalog entity

descriptionstring

Catalog entity description, not updatable for discovery created catalog entity

linksarray of MetadataLinkDto (object)

List of URLs linked to this entity, replaces the existing list

metaTagsarray of MetadataTagDto (object)

List of metadata tags linked to this entity, replaces the existing list

permissionsobject

permissionsPatternsarray of string

generalAccessarray of enum

Entity visibility control. By default it is set to a default access control on organization level

parentsarray of EntityParentDto (object)

Catalog entity's parents, replaces the existing parents list

urlstring

The URL of the repository

contributorsarray of RepositoryContributorDto (object)

The list of contributors for this repository

languagesarray of RepositoryLanguageDto (object)

The languages that this repository uses

releaseall of

The latest release of this repository

provider*enum

The provider of this repository

GitHubBitbucketGitLabAzure DevOps

providerResourceKeystring

The key/ID of this repository in the provider

providerAccountIdstring

The key/ID of the account that owns this repository

locationstring

The full path of the repository

locationGroupstring

The repository project path for nested project providers like GitLab. It can be set to "None" if not applicable.

Response

Body

id*string

name*string

orgId*string

type*enum

Catalog entity type

applicationsystemserviceresourceenvironmentpersonapirepositorylibrarymanifestteambaserangecostvulnerability

descriptionstring

Catalog entity description

metaTagsarray of MetadataTagDto (object)

Catalog entity's metadata

linksarray of MetadataLinkDto (object)

Catalog entity's links

parentsarray of EntityParentDto (object)

Catalog entity's parents

createdBystring

lastChangedBystring

createDateTimestring (date-time)

lastChangedDateTimestring (date-time)

permissionsobject

generalAccessarray of enum

Entity visibility control. By default it is set to a default access control on organization level

url*string

contributors*array of string

languages*array of string

release*RepositoryReleaseDto (object)

provider*string

providerType*string

providerResourceKey*string

providerResourceType*string

providerAccountId*string

location*string

locationGroupstring

detailsobject

Request

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/repository/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "provider": "GitHub"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "type": "application",
  "description": "text",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "label": "belongs_to",
      "field": "text"
    }
  ],
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2024-11-21T06:26:22.085Z",
  "lastChangedDateTime": "2024-11-21T06:26:22.085Z",
  "generalAccess": [
    "read"
  ],
  "url": "text",
  "contributors": [
    "text"
  ],
  "languages": [
    "text"
  ],
  "release": {
    "name": "text",
    "date": "text",
    "tag": "text",
    "latest": false
  },
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text",
  "location": "text",
  "locationGroup": "text"
}

PreviousPerson NextResource

Last updated 2 months ago

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/repository', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text", "url": "text", "provider": "GitHub", "providerResourceKey": "text", "providerAccountId": "text", "location": "text" }), }); const data = await response.json();

{ "id": "text", "name": "text", "orgId": "text", "type": "application", "description": "text", "metaTags": [ { "name": "text", "value": "text", "type": "JSON", "createdBy": "MANUAL" } ], "links": [ { "url": "text", "title": "text", "icon": "text" } ], "parents": [ { "id": "text", "secondaryId": "text", "label": "belongs_to", "field": "text" } ], "createdBy": "text", "lastChangedBy": "text", "createDateTime": "2024-11-21T06:26:22.085Z", "lastChangedDateTime": "2024-11-21T06:26:22.085Z", "generalAccess": [ "read" ], "url": "text", "contributors": [ "text" ], "languages": [ "text" ], "release": { "name": "text", "date": "text", "tag": "text", "latest": false }, "provider": "text", "providerType": "text", "providerResourceKey": "text", "providerResourceType": "text", "providerAccountId": "text", "location": "text", "locationGroup": "text" }

const response = await fetch('https://app.configure8.io/public/v1/catalog/entities/repository/{id}', { method: 'PATCH', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "provider": "GitHub" }), }); const data = await response.json();