Code Repository

Get Code Repository

Endpoint to retrieve a single Code Repository by ID

post/code-repository/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Code Repository to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "repositoryHostedAt": true,
    "organizationName": true,
    "repositoryName": true,
    "mainBranchName": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "My Backend API",
    "slug": "example-slug-value",
    "description": "Main backend API service for user authentication and data access",
    "repositoryHostedAt": "GitHub",
    "organizationName": "my-organization",
    "repositoryName": "my-backend-api",
    "mainBranchName": "main",
    "setupCommand": "npm ci",
    "buildCommand": "npm run build",
    "testCommand": "npm test",
    "runnerId": "123e4567-e89b-12d3-a456-426614174000",
    "isGlobalRunnerPicked": true,
    "maxOpenFixPullRequests": 42,
    "isGitHubCommandsEnabled": true,
    "gitHubTriggerLabel": "oneuptime",
    "isProductionReviewEnabled": true,
    "productionReviewPullRequestContent": "Review",
    "productionReviewLlmProviderId": "123e4567-e89b-12d3-a456-426614174000",
    "repositoryUrl": "https://www.example.com/path/to/resource?param=value",
    "gitHubAppInstallationId": "12345678",
    "gitLabProjectId": "12345678",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.