Help Center> ROMA Connect> API Reference> Public Resource APIs> Application Management> Creating an Application
View PDF

Creating an Application

Function

This API is used to create an application.

URI

POST /v2/{project_id}/instances/{instance_id}/apps

Table 1 Path parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.

Minimum: 0

Maximum: 64

project_id

Yes

String

Project ID.

Minimum: 0

Maximum: 64

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum: 1

Maximum: 100000
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Application name.

  • Characters allowed: letters, digits, hyphens (-), underscores (_), periods (.), spaces, and parentheses.

  • Constraints: The value must be unique in an instance.

remark

No

String

Application description.

key

No

String

Application authentication access key. If no key is specified, a random value is generated.

  • Characters allowed: letters, digits, hyphens (-), underscores (_), at signs (@), and periods (.); The value must start with a letter or digit.

  • Constraints: The value must be unique in an instance.

secret

No

String

Application authentication access secret. If this field does not exist or the value is null, a random value is generated.

  • Characters allowed: letters, digits, and the following special characters: ! @#$%+=.-/

  • Complexity: a combination of uppercase letters, lowercase letters, digits, and special characters. Complexity check is not required.

favorite

No

Boolean

Whether to favorite the application. Favorited applications will be displayed preferentially in the list.

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

id

String

Application ID.

name

String

Application name.

  • Characters allowed: letters, digits, hyphens (-), underscores (_), periods (.), spaces, and parentheses.

  • Constraints: The value must be unique in an instance.

remark

String

Application description.

roles

Array of strings

Application permissions.

  • read: permission to read resources of an application, including API debugging. This permission must be included.

  • access: permission to access resources of an application.

  • delete: permission to delete resources of an application.

  • modify: permission to modify resources of an application, including API release and removal.

  • admin: all permissions on an application and its resources.

  • When only the user admin is provided, all other permissions are automatically applied.

  • The read permission is automatically applied when it is not provided.

create_time

Number

Creation time.

Minimum: 1

Maximum: 128

update_time

Number

Update time.

Minimum: 1

Maximum: 128

created_user

created_user object

Information about the user who created the application.

last_updated_user

last_updated_user object

Information about the user who last updated the application.

owner

Boolean

Whether the user is the owner of the application.

key

String

Application authentication access key. If no key is specified, a random value is generated.

  • Characters allowed: letters, digits, hyphens (-), underscores (_), at signs (@), and periods (.); The value must start with a letter or digit.

  • Constraints: The value must be unique in an instance.

favorite

Boolean

Whether to favorite the application. Favorited applications will be displayed preferentially in the list.
Table 5 created_user

Parameter

Type

Description

user_id

String

ID of the user who created the application.

user_name

String

Name of the user who created the application.
Table 6 last_updated_user

Parameter

Type

Description

user_id

String

ID of the user who last updated the application.

user_name

String

Name of the user who last updated the application.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 1

Maximum: 128

error_msg

String

Error message.

Minimum: 1

Maximum: 128

error_details

String

Error information.

Minimum: 1

Maximum: 128

request_id

String

Request ID.

Minimum: 1

Maximum: 128

Example Requests

{
  "name" : "AppName",
  "remark" : "example",
  "key" : "JNs1VK3vLdTT9Djd",
  "secret" : "TEI95R8RZ2pIf8UM",
  "favorite" : false
}

Example Responses

Status code: 201

OK

{
  "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3",
  "name" : "AppName",
  "remark" : "example",
  "roles" : [ "read, access, delete, modify, admin" ],
  "create_time" : "2019-12-06T06:49:04.000Z",
  "update_time" : "2019-12-06T06:49:04.000Z",
  "created_user" : {
    "user_id" : "string",
    "user_name" : "string"
  },
  "last_updated_user" : {
    "user_id" : "string",
    "user_name" : "string"
  },
  "owner" : true,
  "key" : "TEI95R8RZ2pIf8UM",
  "favorite" : true
}

Status code: 403

Forbidden

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

Status Codes

Status Code

Description

201

OK

403

Forbidden

Error Codes

See Error Codes.

Parent topic: Application Management