Service

Get Service

Endpoint to retrieve a single Service by ID

post/service/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Service to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "serviceVersion": true,
    "deploymentEnvironment": true,
    "serviceNamespace": true,
    "runtimeName": 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": "User Authentication API",
    "slug": "example-slug-value",
    "description": "RESTful API service that handles user authentication, authorization, and session management for the platform",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "isArchived": true,
    "archivedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "archivedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "serviceColor": {
      "_type": "Color",
      "value": "#ff0000"
    },
    "serviceLanguage": "NodeJS",
    "techStack": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "retainTelemetryDataForDays": 42,
    "metricCardinalityBudget": 42,
    "metricDownsamplingRetentionDays": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "telemetryRetentionConfig": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "lastSeenAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "serviceVersion": "Example short text",
    "deploymentEnvironment": "Example short text",
    "serviceNamespace": "Example short text",
    "runtimeName": "Example short text",
    "runtimeVersion": "Example short text",
    "telemetrySdkLanguage": "Example short text",
    "cloudProvider": "Example short text",
    "cloudPlatform": "Example short text",
    "cloudRegion": "Example short text",
    "cloudAccountId": "Example short text"
  }
}

Changes

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