DevOpsAgentService / Client / get_service

get_service¶

DevOpsAgentService.Client.get_service(**kwargs)¶

Retrieves given service by it’s unique identifier

Request Syntax

response = client.get_service(
    serviceId='string'
)

Parameters:

serviceId (string) –

[REQUIRED]

The unique identifier of the given service.

Return type:

dict

Returns:

Response Syntax

{
    'service': {
        'serviceId': 'string',
        'serviceType': 'github'|'slack'|'azure'|'azuredevops'|'dynatrace'|'servicenow'|'pagerduty'|'gitlab'|'eventChannel'|'mcpservernewrelic'|'mcpservergrafana'|'mcpserverdatadog'|'mcpserver'|'mcpserversplunk'|'azureidentity',
        'name': 'string',
        'accessibleResources': [
            {...}|[...]|123|123.4|'string'|True|None,
        ],
        'additionalServiceDetails': {
            'github': {
                'owner': 'string',
                'ownerType': 'organization'|'user',
                'targetUrl': 'string'
            },
            'slack': {
                'teamId': 'string',
                'teamName': 'string'
            },
            'mcpserverdatadog': {
                'name': 'string',
                'endpoint': 'string',
                'authorizationMethod': 'oauth-client-credentials'|'oauth-3lo'|'api-key'|'bearer-token',
                'description': 'string',
                'apiKeyHeader': 'string'
            },
            'mcpserver': {
                'name': 'string',
                'endpoint': 'string',
                'authorizationMethod': 'oauth-client-credentials'|'oauth-3lo'|'api-key'|'bearer-token',
                'description': 'string',
                'apiKeyHeader': 'string'
            },
            'servicenow': {
                'instanceUrl': 'string'
            },
            'gitlab': {
                'targetUrl': 'string',
                'tokenType': 'personal'|'group',
                'groupId': 'string'
            },
            'mcpserversplunk': {
                'name': 'string',
                'endpoint': 'string',
                'authorizationMethod': 'oauth-client-credentials'|'oauth-3lo'|'api-key'|'bearer-token',
                'description': 'string',
                'apiKeyHeader': 'string'
            },
            'mcpservernewrelic': {
                'accountId': 'string',
                'region': 'US'|'EU',
                'description': 'string'
            },
            'azuredevops': {
                'organizationName': 'string'
            },
            'azureidentity': {
                'tenantId': 'string',
                'clientId': 'string',
                'webIdentityRoleArn': 'string',
                'webIdentityTokenAudiences': [
                    'string',
                ]
            },
            'mcpservergrafana': {
                'endpoint': 'string',
                'authorizationMethod': 'oauth-client-credentials'|'oauth-3lo'|'api-key'|'bearer-token'
            },
            'pagerduty': {
                'scopes': [
                    'string',
                ]
            }
        },
        'kmsKeyArn': 'string',
        'privateConnectionName': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –

Output containing the requested service details.
- service (dict) –
  
  Represents a registered service with its configuration and accessible resources.
  - serviceId (string) –
    
    The unique identifier of a service.
  - serviceType (string) –
    
    The service type e.g github or dynatrace
  - name (string) –
    
    The display name of the registered service.
  - accessibleResources (list) –
    
    List of accessible resources for this service.
    - (document) –
  - additionalServiceDetails (dict) –
    
    Additional details specific to the service type.
    Note
    This is a Tagged Union structure. Only one of the following top level keys will be set: github, slack, mcpserverdatadog, mcpserver, servicenow, gitlab, mcpserversplunk, mcpservernewrelic, azuredevops, azureidentity, mcpservergrafana, pagerduty. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    - github (dict) –
      
      GitHub-specific service details.
      - owner (string) –
        
        The GitHub repository owner name.
      - ownerType (string) –
        
        The GitHub repository owner type.
      - targetUrl (string) –
        
        The GitHub Enterprise Server instance URL (absent for github.com).
    - slack (dict) –
      
      Slack-specific service details.
      - teamId (string) –
        
        The Slack team ID.
      - teamName (string) –
        
        The Slack team name.
    - mcpserverdatadog (dict) –
      
      Datadog MCP server-specific service details.
      - name (string) –
        
        The MCP server name.
      - endpoint (string) –
        
        The MCP server endpoint URL.
      - authorizationMethod (string) –
        
        The MCP server uses this authorization method.
      - description (string) –
        
        Optional description for the MCP server.
      - apiKeyHeader (string) –
        
        If the MCP server uses API key authentication, these details are provided.
    - mcpserver (dict) –
      
      MCP server-specific service details.
      - name (string) –
        
        The MCP server name.
      - endpoint (string) –
        
        The MCP server endpoint URL.
      - authorizationMethod (string) –
        
        The MCP server uses this authorization method.
      - description (string) –
        
        Optional description for the MCP server.
      - apiKeyHeader (string) –
        
        If the MCP server uses API key authentication, these details are provided.
    - servicenow (dict) –
      
      ServiceNow-specific service details.
      - instanceUrl (string) –
        
        The ServiceNow instance url
    - gitlab (dict) –
      
      GitLab-specific service details.
      - targetUrl (string) –
        
        The GitLab instance URL.
      - tokenType (string) –
        
        Type of GitLab access token
      - groupId (string) –
        
        Optional GitLab group ID for group-level access tokens
    - mcpserversplunk (dict) –
      
      Splunk MCP server-specific service details.
      - name (string) –
        
        The MCP server name.
      - endpoint (string) –
        
        The MCP server endpoint URL.
      - authorizationMethod (string) –
        
        The MCP server uses this authorization method.
      - description (string) –
        
        Optional description for the MCP server.
      - apiKeyHeader (string) –
        
        If the MCP server uses API key authentication, these details are provided.
    - mcpservernewrelic (dict) –
      
      New Relic MCP server-specific service details.
      - accountId (string) –
        
        The NewRelic account ID.
      - region (string) –
        
        The NewRelic region (determines API endpoint).
      - description (string) –
        
        Optional user description.
    - azuredevops (dict) –
      
      Azure DevOps specific service details.
      - organizationName (string) –
        
        The Azure DevOps Organization name associated with the service.
    - azureidentity (dict) –
      
      Azure identity details for services using Azure authentication.
      - tenantId (string) –
        
        The Azure Active Directory tenant ID for the identity.
      - clientId (string) –
        
        The client ID of the service principal or managed identity used for authentication.
      - webIdentityRoleArn (string) –
        
        The role ARN to be assumed by DevOps Agent for requesting Web Identity Token.
      - webIdentityTokenAudiences (list) –
        
        The audiences for the Web Identity Token.
        
        (string) –
    - mcpservergrafana (dict) –
      
      Grafana MCP server-specific service details.
      - endpoint (string) –
        
        Grafana instance URL (e.g., https://your-instance.grafana.net)
      - authorizationMethod (string) –
        
        The authz method used by the MCP server.
    - pagerduty (dict) –
      
      Pagerduty service details.
      - scopes (list) –
        
        The scopes that were assigned to the service
        
        (string) –
  - kmsKeyArn (string) –
    
    The ARN of the AWS Key Management Service (AWS KMS) customer managed key that’s used to encrypt resources.
  - privateConnectionName (string) –
    
    The name of the private connection used for VPC connectivity.
- tags (dict) –
  
  Tags associated with the Service.
  - (string) –
    
    Tag key string.
    - (string) –
      
      Tag value string.

get_service¶

Request Syntax

Response Syntax

Response Structure

Note

Exceptions