This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

DevOps Service

Overview

Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of DevOps Service service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

VersionStatusSupported Until
1.0CURRENT-

OpenAPI URL

https://devopsservice.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

1 - APIs

1.1 - Check Deletable DevOps Service

1.1.1 - 1.0

get /v1/devops-services/{devops_service_id}/check-deletable

Description

check deletable a specific devops service

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathdevops_service_id
required		DevOps Service ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone

Responses

HTTP CodeDescriptionSchema
200OKDevOpsServiceCheckResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/devops-services/{devops_service_id}/check-deletable

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = devopsservice 1.0"

Example HTTP response

Response 200

{
    "result": false
}

1.2 - Check Duplication DevOps Service

1.2.1 - 1.0

get /v1/devops-services/check-duplication

Description

check duplication a specific devops service

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
querytenant_code
optional		Tenant Code
Example : test-tenant
any of [string, null]None
querytenant_name
optional		Tenant Name
Example : test-tenant
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKDevOpsServiceCheckResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/devops-services/check-duplication

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = devopsservice 1.0"

Example HTTP response

Response 200

{
    "result": false
}

1.3 - Create DevOps Service

1.3.1 - 1.0

post /v1/devops-services

Description

create a devops service

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
DevOpsServiceCreateRequest

Responses

HTTP CodeDescriptionSchema
201CreatedDevOpsServiceShowResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/devops-services

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = devopsservice 1.0"

Request body

{
    "members": [
        ""
    ],
    "tags": [
        {
            "key": "",
            "value": ""
        }
    ],
    "tenant_code": "",
    "tenant_name": ""
}

Example HTTP response

Response 201

{
    "devops_service": {
        "account_id": "",
        "console_url": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "status": "",
        "tenant_code": "",
        "tenant_name": ""
    }
}

1.4 - Delete DevOps Service

1.4.1 - 1.0

delete /v1/devops-services/{devops_service_id}

Description

delete a specific devops service

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathdevops_service_id
required		DevOps Service ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/devops-services/{devops_service_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = devopsservice 1.0"

Example HTTP response

Response 204

1.5 - List DevOps Services

1.5.1 - 1.0

get /v1/devops-services

Description

get devops service list

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Responses

HTTP CodeDescriptionSchema
200OKDevOpsServiceListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/devops-services

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = devopsservice 1.0"

Example HTTP response

Response 200

{
    "count": 1,
    "devops_services": [
        {
            "account_id": "",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "status": "",
            "tenant_code": "",
            "tenant_name": ""
        }
    ]
}

1.6 - Show DevOps Service

1.6.1 - 1.0

get /v1/devops-services/{devops_service_id}

Description

show a specific devops service

State ACTIVE (CURRENT)

VersionSupported Until
1.0-

Parameters

TypeNameDescriptionSchemaDefault
pathdevops_service_id
required		DevOps Service ID
Example : 138c2fc8c29a449dbfa8681f8f1d78e2
stringNone

Responses

HTTP CodeDescriptionSchema
200OKDevOpsServiceShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/devops-services/{devops_service_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = devopsservice 1.0"

Example HTTP response

Response 200

{
    "devops_service": {
        "account_id": "",
        "console_url": "",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "id": "0fdd87aab8cb46f59b7c1f81ed03fb3e",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "status": "",
        "tenant_code": "",
        "tenant_name": ""
    }
}

2 - Models

2.1 - DevOpsService

NameDescriptionSchemaDefault
account_id
required		Account ID
Example :
string
console_url
required		DevOps Service Console URL
Example :
string
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required		ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
status
required		DevOps Service Status
Example :
string
tenant_code
required		Tenant Code
Example :
string
tenant_name
required		Tenant Name
Example :
string

2.2 - DevOpsServiceCheckResponse

NameDescriptionSchemaDefault
result
required		DevOps Service Check Result
Example : False
boolean

2.3 - DevOpsServiceCreateRequest

NameDescriptionSchemaDefault
members
required		Tenant Members
array[string]
tags
optional		Tag List
any of [array[Tag], null]
tenant_code
required		Tenant Code
Example :
Pattern : ^[a-z0-9\-]*$
string
tenant_name
required		Tenant Name
Example :
Pattern : ^[a-z0-9\-]*$
string

2.4 - DevOpsServiceListResponse

NameDescriptionSchemaDefault
count
required		DevOps Service Current Count
Example : 1
integer
devops_services
required
array[DevOpsServiceSummary]

2.5 - DevOpsServiceShowResponse

NameDescriptionSchemaDefault
devops_service
required
DevOpsService

2.6 - DevOpsServiceSummary

NameDescriptionSchemaDefault
account_id
required		Account ID
Example :
string
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
id
required		ID
Example : 0fdd87aab8cb46f59b7c1f81ed03fb3e
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
status
required		DevOps Service Status
Example :
string
tenant_code
required		Tenant Code
Example :
string
tenant_name
required		Tenant Name
Example :
string

2.7 - Tag

NameDescriptionSchemaDefault
key
required		tag key
Example :
string
value
required		tag value
Example :
string