Project

Get Project

Endpoint to retrieve a single Project by ID

post/project/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Project to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "paymentProviderPlanId": true,
    "paymentProviderSubscriptionId": true,
    "paymentProviderMeteredSubscriptionId": true,
    "paymentProviderCustomerId": 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,
    "name": "My Awesome Project",
    "slug": "example-slug-value",
    "paymentProviderPlanId": "Example short text",
    "paymentProviderSubscriptionId": "Example short text",
    "paymentProviderMeteredSubscriptionId": "Example short text",
    "paymentProviderSubscriptionSeats": 42,
    "trialEndsAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "paymentProviderCustomerId": "Example short text",
    "businessDetails": "Acme Corporation\n123 Main Street\nSan Francisco, CA 94102\nTax ID: 12-3456789",
    "businessDetailsCountry": "US",
    "financeAccountingEmail": "accounting@example.com, finance@example.com",
    "paymentProviderSubscriptionStatus": "incomplete",
    "paymentProviderMeteredSubscriptionStatus": "incomplete",
    "paymentProviderPromoCode": "Example short text",
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "isFeatureFlagMonitorGroupsEnabled": true,
    "workflowRunsInLast30Days": 42,
    "requireSsoForLogin": true,
    "requireSsoWithSsoProviderId": "123e4567-e89b-12d3-a456-426614174000",
    "incidentNumberPrefix": "Example short text",
    "alertNumberPrefix": "Example short text",
    "scheduledMaintenanceNumberPrefix": "Example short text",
    "securityCaseNumberPrefix": "SOC-",
    "incidentEpisodeNumberPrefix": "Example short text",
    "alertEpisodeNumberPrefix": "Example short text",
    "incidentNumbersStartAt": 42,
    "incidentEpisodeNumbersStartAt": 42,
    "alertNumbersStartAt": 42,
    "alertEpisodeNumbersStartAt": 42,
    "scheduledMaintenanceNumbersStartAt": 42,
    "securityCaseNumbersStartAt": 42,
    "smsOrCallCurrentBalanceInUSDCents": 42,
    "autoRechargeSmsOrCallByBalanceInUSD": 42,
    "autoRechargeSmsOrCallWhenCurrentBalanceFallsInUSD": 42,
    "enableSmsNotifications": true,
    "enableWhatsAppNotifications": true,
    "enableTelegramNotifications": true,
    "enableCallNotifications": true,
    "disableOnCallNotificationFallback": true,
    "enableAutoRechargeSmsOrCallBalance": true,
    "aiCurrentBalanceInUSDCents": 42,
    "autoAiRechargeByBalanceInUSD": 42,
    "autoRechargeAiWhenCurrentBalanceFallsInUSD": 42,
    "enableAi": true,
    "aiContext": "# Heading\n\nThis is **markdown** content",
    "aiDailyTokenLimit": 42,
    "aiDailySpendLimitInUSD": 42,
    "enableAutomaticIncidentInvestigation": true,
    "enableAutomaticAlertInvestigation": true,
    "enableAutomaticSecurityCaseTriage": true,
    "enableSecurityRiskCases": true,
    "securityRiskCaseThreshold": 42,
    "enableAutomaticIncidentRemediation": true,
    "enableAutomaticAlertRemediation": true,
    "enableAutomaticPostmortemDraft": true,
    "acknowledgeLinkedAlertsWhenIncidentAcknowledged": true,
    "resolveLinkedAlertsWhenIncidentResolved": true,
    "limitIncidentsToOneEpisode": true,
    "limitAlertsToOneEpisode": true,
    "defaultNetworkTopologyLayout": "parentChild",
    "enableAiInsights": true,
    "enableInsightFixTasks": true,
    "enableAutomaticProfileRemediation": true,
    "enableAutomaticTraceRemediation": true,
    "enableAutomaticExceptionRemediation": true,
    "enableAutomaticMetricRemediation": true,
    "enableAutomaticLogRemediation": true,
    "autoArchiveNonActionableExceptions": true,
    "alertInvestigationMinimumSeverityId": "123e4567-e89b-12d3-a456-426614174000",
    "aiDailyAutonomousTokenLimit": 42,
    "incidentAiDailyAutonomousTokenLimit": 42,
    "alertAiDailyAutonomousTokenLimit": 42,
    "aiDailyFixTaskLimit": 42,
    "incidentAiDailyFixTaskLimit": 42,
    "alertAiDailyFixTaskLimit": 42,
    "alertInvestigationDedupeWindowMinutes": 42,
    "incidentInvestigationMinimumSeverityId": "123e4567-e89b-12d3-a456-426614174000",
    "incidentInvestigationDedupeWindowMinutes": 42,
    "aiMaxConcurrentInvestigations": 42,
    "incidentAiMaxConcurrentInvestigations": 42,
    "alertAiMaxConcurrentInvestigations": 42,
    "incidentAiInvestigationTimeLimitInMinutes": 42,
    "alertAiInvestigationTimeLimitInMinutes": 42,
    "enableAutoRechargeAiBalance": true,
    "sendInvoicesByEmail": true,
    "planName": "Free",
    "dataResidency": "Example short text",
    "resellerId": "123e4567-e89b-12d3-a456-426614174000",
    "resellerPlanId": "123e4567-e89b-12d3-a456-426614174000",
    "billingMarketplace": "AWS",
    "letCustomerSupportAccessProject": true,
    "doNotAddGlobalProbesByDefaultOnNewMonitors": true,
    "useGlobalRunners": true,
    "gitHubAppInstallationId": "This is an example of longer text content that might be stored in this field.",
    "defaultMetricCardinalityBudget": 42,
    "defaultTelemetryRetentionInDays": 42,
    "telemetryRetentionConfig": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "defaultMetricDownsamplingRetentionDays": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "enableAuditLogs": true,
    "isSessionReplayAllowed": true,
    "auditLogsRetentionInDays": 42,
    "storeSystemEventsInAuditLogs": true,
    "recordAndTranscribeIncidentCalls": true
  }
}

Changes

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