Repository

PreviousLibrary and Manifest NextResource

Last updated 2 months ago

Update a repository catalog entity

patch

/public/v1/catalog/entities/repository/{id}

Path parameters

idstringrequired

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

replaceMetadataTagsboolean

Replace metadata tags with the provided list

urlstring

The URL of the repository

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.

providerstring · enumrequired

The provider of this repository

Options: GitHub, Bitbucket, GitLab, Azure DevOps

linksobject[]

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

metaTagsobject[]

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

permissionsPatternsstring[]

parentsobject[]

Catalog entity's parents, replaces the existing parents list

contributorsobject[]

The list of contributors for this repository

languagesobject[]

The languages that this repository uses

generalAccessstring · enum[]

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

releaseall of

The latest release of this repository

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://app.configure8.io/public/v1/catalog/entities/repository/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"provider":"GitHub","links":[{"url":"text","title":"text","icon":"text"}],"metaTags":[{"name":"text","value":"text","type":"JSON","createdBy":"MANUAL"}],"permissionsPatterns":[null],"parents":[{"id":"text","secondaryId":"text","field":"text","label":"belongs_to"}],"contributors":[{"id":"text","login":"text"}],"languages":[{"name":"text","lines":1,"percent":1}],"generalAccess":["read"],"release":{"name":"text","date":"text","tag":"text","latest":true},"permissions":{"ANY_ADDITIONAL_PROPERTY":["create"]}}'

200

401

403

404

409

422

{
  "id": "text",
  "name": "text",
  "orgId": "text",
  "description": "text",
  "createdBy": "text",
  "lastChangedBy": "text",
  "createDateTime": "2025-02-21T18:02:53.322Z",
  "lastChangedDateTime": "2025-02-21T18:02:53.322Z",
  "url": "text",
  "release": {
    "name": "text",
    "date": "text",
    "tag": "text",
    "latest": true
  },
  "provider": "text",
  "providerType": "text",
  "providerResourceKey": "text",
  "providerResourceType": "text",
  "providerAccountId": "text",
  "location": "text",
  "locationGroup": "text",
  "details": {},
  "type": "application",
  "metaTags": [
    {
      "name": "text",
      "value": "text",
      "type": "JSON",
      "createdBy": "MANUAL"
    }
  ],
  "links": [
    {
      "url": "text",
      "title": "text",
      "icon": "text"
    }
  ],
  "parents": [
    {
      "id": "text",
      "secondaryId": "text",
      "field": "text",
      "label": "belongs_to"
    }
  ],
  "contributors": [
    "text"
  ],
  "languages": [
    "text"
  ],
  "generalAccess": [
    "read"
  ],
  "permissions": {
    "ANY_ADDITIONAL_PROPERTY": [
      "create"
    ]
  }
}

Create an new repository catalog entity

post

/public/v1/catalog/entities/repository