MENU
      Scenario details

        Scenario details


        Article summary

        Overview

        Views the scenario details of the SourceDeploy project.

        Requests

        API URL

        GET 	{SOURCEDEPLOY_API_URL}/project/{projectId}/stage/{stageId}/scenario/{scenarioId}
        Plain text

        Request parameters

        ItemTypeDescriptionNote
        projectIdstringProject IDView with projectList API
        stageIdstringstage IDView with stageList API
        scenarioIdstringScenario IDView with scenarioList API

        Request queries

        None

        Request bodies

        None

        Responses

        Response bodies

        {
            "project": {
                "id": "number",
                "name": "string"
            },
            "stage": {
                "id": "number",
                "name": "string"
            },
            "id": "number",
            "name": "string",
            "description": "string",
            "type": "string",
            "config": "TScenarioServer" | "TScenarioAutoScaling" | "TSecnarioKubernetesService" | "TSecnarioObjectStorage"
        }
        JSON
        ItemTypeDescriptionNote
        project.idnumberProject ID
        project.namestringProject name
        stage.idnumberstage id
        stage.namestringStage name
        idnumberScenario ID
        namestringScenario name
        descriptionstringScenario description
        typestringDeployment target type"Server"
        ConfigTScenarioServerTScenarioAutoScalingGroupTSecnarioKubernetesService

        TScenarioServer

        {
          "strategy": "string",
          "sequence": "boolean",
          "file": {
            "type": "string",
            "ObjectStorage": {
              "bucket": "string",
              "object": "string"
            },
            "SourceBuild": {
              "id": "number",
              "name": "string"
            }
          },
          "rollback": "boolean",
          "cmd": {
            "pre": [
              {
                "user": "string",
                "cmd": "string"
              }
            ],
            "deploy": [
              {
                "sourcePath": "string",
                "deployPath": "string"
              }
            ],
            "post": [
              {
                "user": "string",
                "cmd": "string"
              }
            ]
          }
        }
        JSON
        ItemTypeDescriptionNote
        strategystringDeployment strategy"normal"
        sequencebooleanConsecutive deployment status
        file.typestringDeployment file type"ObjectStorage"
        file.ObjectStorage.bucketstringObjectStorage bucket namefile.type=ObjectStorage
        file.ObjectStorage.objectstringObjectStorage object locationfile.type=ObjectStorage
        file.SourceBuild.idnumberSourceBuild idfile.type=SourceBuild
        file.SourceBuild.namestringSourceBuild project namefile.type=SourceBuild
        rollbackbooleanRoll back if deployment fails
        cmd.pre.userstringRun before deployment>Account
        cmd.pre.cmdstringRun before deployment>Command
        cmd.deploy.sourcePathstringFile deployment>Source file path
        cmd.deploy.deployPathstringFile deployment>Deployment path
        cmd.post.userstringRun after deployment>Account
        cmd.post.cmdstringRun after deployment>Command

        TScenarioAutoScalingGroup

        {
          "strategy": "string",
          "sequence": "boolean",
          "file": {
            "type": "string",
            "ObjectStorage": {
              "bucket": "string",
              "object": "string"
            },
            "SourceBuild": {
              "id": "number",
              "name": "string"
            }
          },
          "rollback": "boolean",
          "cmd": {
            "pre": [
              {
                "user": "string",
                "cmd": "string"
              }
            ],
            "deploy": [
              {
                "sourcePath": "string",
                "deployPath": "string"
              }
            ],
            "post": [
              {
                "user": "string",
                "cmd": "string"
              }
            ]
          },
          "loadBalancer": {
            "loadBalancerTargetGroupNo": "number",
            "loadBalancerTargetGroupName": "string",
            "deleteAsg": "boolean",
            "deleteServer": "boolean"
          }
        }
        JSON
        ItemTypeDescriptionNote
        strategystringDeployment strategy"normal"
        sequencebooleanConsecutive deployment status
        file.typestringDeployment file type"ObjectStorage"
        file.ObjectStorage.bucketstringObjectStorage bucket namefile.type=ObjectStorage
        file.ObjectStorage.objectstringObjectStorage object locationfile.type=ObjectStorage
        file.SourceBuild.idnumberSourceBuild idfile.type=SourceBuild
        file.SourceBuild.namestringSourceBuild project namefile.type=SourceBuild
        rollbackbooleanRoll back if deployment fails
        cmd.pre.userstringRun before deployment>Account
        cmd.pre.cmdstringRun before deployment>Command
        cmd.deploy.sourcePathstringFile deployment>Source file path
        cmd.deploy.deployPathstringFile deployment>Deployment path
        cmd.post.userstringRun after deployment>Account
        cmd.post.cmdstringRun after deployment>Command
        loadBalancer.loadBalancerTargetGroupNonumberLoad Balancer target group numberstrategy=blueGreen
        loadBalancer.loadBalancerTargetGroupNamestringLoad Balancer target group namestrategy=blueGreen
        loadBalancer.deleteAsgbooleanExisting Auto Scaling Group deletion statusstrategy=blueGreen
        loadBalancer.deleteServerbooleanDeletion status of server in the existing Auto Scaling Groupstrategy=blueGreen

        TSecnarioKubernetesService

        {
          "manifest": {
            "type": "string",
            "url": "string",
            "serverUrl": "string",
            "owner": "string",
            "repository": "string",
            "branch": "string",
            "path": ["string"]
          },
          "strategy": "string",
          "canaryConfig": {
            "canaryCount": "number",
            "analysisType": "string",
            "timeout": "number",
            "prometheus": "string",
            "env": {
              "baseline": "string",
              "canary": "string"
            },
            "metrics": [
              {
                "name": "string",
                "successCriteria": "string",
                "queryType": "string",
                "weight": "number",
                "metric": "string",
                "filter": "string",
                "query": "string"
              }
            ],
            "analysisConfig": {
              "duration": "number",
              "delay": "number",
              "interval": "number",
              "step": "number"
            },
            "passScore": "number"
          }
        }
        JSON
        ItemTypeDescriptionNote
        strategystringDeployment strategy"rolling"
        manifest.typestringManifest file repository"SourceCommit"
        manifest.urlstringRepository URLWhen manifest.type=Github Enterprise Server and logged in with an SSH key
        manifest.serverUrlstringServer URLWhen manifest.type=Github Enterprise Server and logged in with OAuth, Personal Access Token, or Username/Password
        manifest.ownerstringOwnerWhen manifest.type=Github Enterprise Server
        manifest.repositorystringRepository
        manifest.branchstringRepository branch
        manifest.pathstring[]File location
        canaryConfig.analysisTypestringCanary analysis methodWhen strategy=canary,
        "manual"
        canaryConfig.timeoutnumberMaximum time of deployment/cancellationWhen strategy=canary & canaryConfig.analysisType=manual
        canaryConfig.canaryCountnumberNumber of baselines and canary podsWhen strategy=canary & (canaryConfig.analysisType=manual
        canaryConfig.prometheusstringPrometheus UrlWhen strategy=canary & canaryConfig.analysisType=auto
        canaryConfig.env.baselinestringAnalysis environment variable > baselineWhen strategy=canary & canaryConfig.analysisType=auto
        canaryConfig.env.canarystringAnalysis environment variable > canaryWhen strategy=canary & canaryConfig.analysisType=auto
        canaryConfig.metrics.namestringMetric nameWhen strategy=canary & canaryConfig.analysisType=auto
        canaryConfig.metrics.successCriteriastringSucceeded criteriaWhen strategy=canary & canaryConfig.analysisType=auto
        "base"
        canaryConfig.metrics.queryTypestringQuery typeWhen strategy=canary & canaryConfig.analysisType=auto
        "default"
        canaryConfig.metrics.weightnumberWeightstrategy=canary & canaryConfig.analysisType=auto
        canaryConfig.metrics.metricstringMetricstrategy=canary & canaryConfig.analysisType=auto &canaryConfig.metrics.queryType="default"
        canaryConfig.metrics.filterstringFilterstrategy=canary & canaryConfig.analysisType=auto &canaryConfig.metrics.queryType="default"
        canaryConfig.metrics.querystringQuerystrategy=canary & canaryConfig.analysisType=auto & canaryConfig.metrics.queryType="promQL"
        canaryConfig.analysisConfig.durationnumberAnalysis timestrategy=canary & canaryConfig.analysisType=auto
        canaryConfig.analysisConfig.delaynumberAnalysis delay timestrategy=canary & canaryConfig.analysisType=auto
        canaryConfig.analysisConfig.intervalnumberAnalysis cyclestrategy=canary & canaryConfig.analysisType=auto
        canaryConfig.analysisConfig.stepnumberMetric collection cyclestrategy=canary & canaryConfig.analysisType=auto
        canaryConfig.passScorenumberAnalysis success scorestrategy=canary & canaryConfig.analysisType=auto

        TSecnarioObjectStorage

        {
          "file": {
            "type": "string",
            "ObjectStorage": {
              "bucket": "string",
              "object": "string"
            },
            "SourceBuild": {
              "id": "number",
              "name": "string"
            }
          },
          "path": [
            {
              "sourcePath": "string",
              "deployPath": "string"
            }
          ]
        }
        JSON
        ItemTypeDescriptionNote
        file.typestringDeployment file type"ObjectStorage"
        file.ObjectStorage.bucketstringObjectStorage bucket namefile.type=ObjectStorage
        file.ObjectStorage.objectstringObjectStorage object locationfile.type=ObjectStorage
        file.SourceBuild.idnumberSourceBuild idfile.type=SourceBuild
        file.SourceBuild.namestringSourceBuild project namefile.type=SourceBuild
        path.sourcePathstringSource file path
        path.deployPathstringDeployment path

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.