Help Center/ CodeArts Pipeline/ API Reference/ API/ Endpoint Management/ Creating a Service Endpoint
Updated on 2025-03-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Service Endpoint

Function

This API is used to create a service endpoint.

Calling Method

For details, see Calling APIs.

URI

POST /v1/serviceconnection/endpoints

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

url

No

String

url

name

No

String

Endpoint name.

project_uuid

No

String

Project ID.

region_name

No

String

Region.

module_id

No

String

module id

authorization

No

EndpointAuthorizationBody object

Permission information.

data

No

Object

Endpoint data structure.
Table 2 EndpointAuthorizationBody

Parameter

Mandatory

Type

Description

parameters

No

Object

Authentication parameter.

scheme

No

String

Authentication mode.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

error

ErrorInfo object

Error information.

result

Object

Error result.

status

String

Status value.
Table 4 ErrorInfo

Parameter

Type

Description

code

String

Error code.

message

String

Error Information.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent Topic: Endpoint Management