Updating a Service Endpoint

Function

This API is used to update a service endpoint.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/serviceconnection/endpoints/{uuid}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
uuid	Yes	String	Definition: Endpoint UUID. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
url	No	String	Definition: Endpoint URL. Constraints: N/A Value range: N/A Default value: N/A
name	No	String	Definition: Endpoint name. Constraints: N/A Value range: N/A Default value: N/A
authorization	No	EndpointAuthorizationBody object	Definition: Permission information. Constraints: N/A Value range: N/A Default value: N/A
data	No	Object	Definition: Endpoint details. Constraints: N/A Value range: N/A Default value: N/A
region_name	No	String	Definition: Region name. Constraints: N/A Value range: N/A Default value: N/A
project_uuid	No	String	Definition: Project ID. Constraints: N/A Value range: N/A Default value: N/A
module_id	No	String	Definition: Endpoint type. Constraints: N/A Value range: N/A Default value: N/A

**Table 3** EndpointAuthorizationBody
Parameter	Mandatory	Type	Description
parameters	No	Object	Definition: Authentication parameter. Constraints: N/A Value range: N/A Default value: N/A
scheme	No	String	Definition: Authentication mode. Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result	result object	Definition: Returned result. Value range: N/A
status	String	Definition: Returned status. Value range: N/A
error	String	Definition: Returned error information. Value range: N/A

**Table 5** result
Parameter	Type	Description
authorization	authorization object	Definition: Authentication information. Value range: N/A
uuid	String	Definition: Unique ID. Value range: N/A
url	String	Definition: URL for downloading the code repository. Value range: N/A
name	String	Definition: Name. Value range: N/A
project_uuid	String	Definition: Project ID. Value range: N/A
region_name	String	Definition: Region name. Value range: N/A
data	Object	Definition: Data details. Value range: N/A
module_id	String	Definition: Template ID. Value range: N/A
created_by	created_by object	Definition: Creator information. Value range: N/A

**Table 6** authorization
Parameter	Type	Description
parameters	parameters object	Definition: Parameter. Value range: N/A
scheme	String	Definition: Plan. Value range: N/A

**Table 7** parameters
Parameter	Type	Description
username	String	Definition: Username. Value range: N/A
code	String	Definition: Code content. Value range: N/A
state	String	Definition: Status. Value range: N/A
redirectURI	String	Definition: Redirection URI. Value range: N/A
password	String	Definition: Password. Value range: N/A

**Table 8** created_by
Parameter	Type	Description
username	String	Definition: Creator name. Value range: N/A
user_id	String	Definition: Creator ID. Value range: N/A

Status code: 201

Created

Example Requests

PUT https://{endpoint}/v1/serviceconnection/endpoints/d09e73b6c61e439fbe2ec93e0b29185b

{
  "project_uuid" : "93b9fc6ffc6a4edc9ab049c1f0dbec4b",
  "region_name" : "region",
  "authorization" : {
    "parameters" : {
      "username" : "username",
      "code" : null,
      "state" : null,
      "redirectURI" : null,
      "password" : "password"
    },
    "scheme" : "endpoint-auth-scheme-basic"
  },
  "data" : { },
  "name" : "ddddd",
  "url" : "https://example.com/maven.git",
  "module_id" : "devcloud2018.codesource-authenticate-generic.oauth02"
}

Example Responses

Status code: 200

{
  "result" : {
    "authorization" : {
      "parameters" : {
        "username" : "username",
        "code" : null,
        "state" : null,
        "redirectURI" : null,
        "password" : "password"
      },
      "scheme" : "endpoint-auth-scheme-basic"
    },
    "uuid" : "d09e73b6c61e439fbe2ec93e0b29185b",
    "url" : "https://example.com/maven.git",
    "name" : "ddddd",
    "project_uuid" : "93b9fc6ffc6a4edc9ab049c1f0dbec4b",
    "region_name" : "region",
    "data" : { },
    "module_id" : "devcloud2018.codesource-authenticate-generic.oauth02",
    "created_by" : {
      "username" : "username",
      "user_id" : "05d8ca972f114765a8984795a8aa4d41"
    }
  },
  "status" : "success",
  "error" : null
}