DBSAFER 객체 관리 API

DBSAFER 객체(접속계정, 어플리케이션, 데이터마스킹, IP 주소) 관리 API를 소개합니다.

1. 접속계정 관리

1.1. 접속계정 목록 조회

등록된 접속계정 목록을 조회하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.1.1. HTTP request

GET /dbsafer/api/v1/object/access-accounts HTTP/1.1
Accept: application/json
Host: localhost:3182

1.1.2. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 190

{
  "results" : [ {
    "index" : 1,
    "id" : "account001",
    "startDate" : "2022-01-01T00:00:00",
    "endDate" : "2022-12-31T23:59:59",
    "comment" : "comment for account001"
  } ]
}

1.1.3. Response fields

Name Type Description Required

results.[].index

Number

접속계정 Index

results.[].id

String

접속계정 ID

results.[].startDate

String

유효기간 시작일

results.[].endDate

String

유효기간 종료일

results.[].comment

String

설명

1.1.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/access-accounts' -i -X GET \
    -H 'Accept: application/json'

1.2. 접속계정 조회

등록된 접속계정을 조회하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.2.1. HTTP request

GET /dbsafer/api/v1/object/access-accounts/1 HTTP/1.1
Accept: application/json
Host: localhost:3182

1.2.2. Path parameters

Table 1. /dbsafer/api/v1/object/access-accounts/{index}
Parameter Description

index

접속계정 Index

1.2.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 156

{
  "index" : 1,
  "id" : "account001",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for account001"
}

1.2.4. Response fields

Name Type Description Required

index

Number

접속계정 Index

id

String

접속계정 ID

startDate

String

유효기간 시작일

endDate

String

유효기간 종료일

comment

String

설명

1.2.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/access-accounts/1' -i -X GET \
    -H 'Accept: application/json'

1.3. 접속계정 추가

신규 접속계정을 추가하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.3.1. HTTP request

POST /dbsafer/api/v1/object/access-accounts HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 141
Host: localhost:3182

{
  "id" : "account001",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for account001"
}

1.3.2. Request fields

Name Type Description Required

id

String

접속계정 ID

startDate

String

유효기간 시작일

endDate

String

유효기간 종료일

comment

String

설명

1.3.3. HTTP response

HTTP/1.1 201 Created

1.3.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/access-accounts' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "id" : "account001",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for account001"
}'

1.4. 접속계정 수정

등록된 접속계정 정보를 수정하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.4.1. HTTP request

PUT /dbsafer/api/v1/object/access-accounts/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 141
Host: localhost:3182

{
  "id" : "account001",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for account001"
}

1.4.2. Path parameters

Table 1. /dbsafer/api/v1/object/access-accounts/{index}
Parameter Description

index

접속계정 Index

1.4.3. Request fields

Name Type Description Required

id

String

접속계정 ID

startDate

String

유효기간 시작일

endDate

String

유효기간 종료일

comment

String

설명

1.4.4. HTTP response

HTTP/1.1 200 OK

1.4.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/access-accounts/1' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "id" : "account001",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for account001"
}'

1.5. 접속계정 삭제

등록된 접속계정을 삭제하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

1.5.1. HTTP request

DELETE /dbsafer/api/v1/object/access-accounts/1 HTTP/1.1
Host: localhost:3182

1.5.2. Path parameters

Table 1. /dbsafer/api/v1/object/access-accounts/{index}
Parameter Description

index

접속계정 Index

1.5.3. HTTP response

HTTP/1.1 204 No Content

1.5.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/access-accounts/1' -i -X DELETE

2. 어플리케이션 관리

2.1. 어플리케이션 목록 조회

등록된 어플리케이션 목록을 조회하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

2.1.1. HTTP request

GET /dbsafer/api/v1/object/applications HTTP/1.1
Accept: application/json
Host: localhost:3182

2.1.2. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 200

{
  "results" : [ {
    "index" : 1,
    "name" : "application001",
    "startDate" : "2022-01-01T00:00:00",
    "endDate" : "2022-12-31T23:59:59",
    "comment" : "comment for application001"
  } ]
}

2.1.3. Response fields

Name Type Description Required

results.[].index

Number

어플리케이션 Index

results.[].name

String

어플리케이션 명

results.[].startDate

String

유효기간 시작일

results.[].endDate

String

유효기간 종료일

results.[].comment

String

설명

2.1.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/applications' -i -X GET \
    -H 'Accept: application/json'

2.2. 어플리케이션 조회

등록된 어플리케이션을 조회하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

2.2.1. HTTP request

GET /dbsafer/api/v1/object/applications/1 HTTP/1.1
Accept: application/json
Host: localhost:3182

2.2.2. Path parameters

Table 1. /dbsafer/api/v1/object/applications/{index}
Parameter Description

index

어플리케이션 Index

2.2.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 166

{
  "index" : 1,
  "name" : "application001",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for application001"
}

2.2.4. Response fields

Name Type Description Required

index

Number

어플리케이션 Index

name

String

어플리케이션 명

startDate

String

유효기간 시작일

endDate

String

유효기간 종료일

comment

String

설명

2.2.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/applications/1' -i -X GET \
    -H 'Accept: application/json'

2.3. 어플리케이션 추가

신규 어플리케이션을 추가하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

2.3.1. HTTP request

POST /dbsafer/api/v1/object/applications HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 151
Host: localhost:3182

{
  "name" : "application001",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for application001"
}

2.3.2. Request fields

Name Type Description Required

name

String

어플리케이션 명

startDate

String

유효기간 시작일

endDate

String

유효기간 종료일

comment

String

설명

owner

String

소유자

2.3.3. HTTP response

HTTP/1.1 201 Created

2.3.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/applications' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "name" : "application001",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for application001"
}'

2.4. 어플리케이션 수정

등록된 어플리케이션 정보를 수정하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

2.4.1. HTTP request

PUT /dbsafer/api/v1/object/applications/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 151
Host: localhost:3182

{
  "name" : "application001",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for application001"
}

2.4.2. Path parameters

Table 1. /dbsafer/api/v1/object/applications/{index}
Parameter Description

index

어플리케이션 Index

2.4.3. Request fields

Name Type Description Required

name

String

어플리케이션 명

startDate

String

유효기간 시작일

endDate

String

유효기간 종료일

comment

String

설명

2.4.4. HTTP response

HTTP/1.1 200 OK

2.4.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/applications/1' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "name" : "application001",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for application001"
}'

2.5. 어플리케이션 삭제

등록된 어플리케이션을 삭제하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

2.5.1. HTTP request

DELETE /dbsafer/api/v1/object/applications/1 HTTP/1.1
Host: localhost:3182

2.5.2. Path parameters

Table 1. /dbsafer/api/v1/object/applications/{index}
Parameter Description

index

어플리케이션 Index

2.5.3. HTTP response

HTTP/1.1 204 No Content

2.5.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/applications/1' -i -X DELETE

3. 데이터마스킹 관리

3.1. 데이터마스킹 목록 조회

등록된 데이터마스킹 목록을 조회하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

3.1.1. HTTP request

GET /dbsafer/api/v1/object/datamasks HTTP/1.1
Accept: application/json
Host: localhost:3182

3.1.2. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 244

{
  "results" : [ {
    "index" : 1,
    "name" : "datamask001",
    "kind" : "REGEX",
    "value" : "/^[0-9]*$/",
    "startDate" : "2022-01-01T00:00:00",
    "endDate" : "2022-12-31T23:59:59",
    "comment" : "comment for datamask001"
  } ]
}

3.1.3. Response fields

Name Type Description Required

results.[].index

Number

데이터마스킹 Index

results.[].name

String

데이터마스킹 명

results.[].kind

String

데이터마스킹 종류 (REGEX/COLUMN)

results.[].value

String

데이터마스킹 값

results.[].startDate

String

유효기간 시작일

results.[].endDate

String

유효기간 종료일

results.[].comment

String

설명

3.1.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/datamasks' -i -X GET \
    -H 'Accept: application/json'

3.2. 데이터마스킹 조회

등록된 데이터마스킹을 조회하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

3.2.1. HTTP request

GET /dbsafer/api/v1/object/datamasks/1 HTTP/1.1
Accept: application/json
Host: localhost:3182

3.2.2. Path parameters

Table 1. /dbsafer/api/v1/object/datamasks/{index}
Parameter Description

index

데이터마스킹 Index

3.2.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 206

{
  "index" : 1,
  "name" : "datamask001",
  "kind" : "REGEX",
  "value" : "/^[0-9]*$/",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for datamask001"
}

3.2.4. Response fields

Name Type Description Required

index

Number

데이터마스킹 Index

name

String

데이터마스킹 명

kind

String

데이터마스킹 종류 (REGEX/COLUMN)

value

String

데이터마스킹 값

startDate

String

유효기간 시작일

endDate

String

유효기간 종료일

comment

String

설명

3.2.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/datamasks/1' -i -X GET \
    -H 'Accept: application/json'

3.3. 데이터마스킹 추가

신규 데이터마스킹을 추가하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

3.3.1. HTTP request

POST /dbsafer/api/v1/object/datamasks HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 191
Host: localhost:3182

{
  "name" : "datamask001",
  "kind" : "REGEX",
  "value" : "/^[0-9]*$/",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for datamask001"
}

3.3.2. Request fields

Name Type Description Required

name

String

데이터마스킹 명

kind

String

데이터마스킹 종류 (REGEX/COLUMN)

value

String

데이터마스킹 값

startDate

String

유효기간 시작일

endDate

String

유효기간 종료일

comment

String

설명

owner

String

소유자

3.3.3. HTTP response

HTTP/1.1 201 Created

3.3.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/datamasks' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "name" : "datamask001",
  "kind" : "REGEX",
  "value" : "/^[0-9]*$/",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for datamask001"
}'

3.4. 데이터마스킹 수정

등록된 데이터마스킹 정보를 수정하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

3.4.1. HTTP request

PUT /dbsafer/api/v1/object/datamasks/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 191
Host: localhost:3182

{
  "name" : "datamask001",
  "kind" : "REGEX",
  "value" : "/^[0-9]*$/",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for datamask001"
}

3.4.2. Path parameters

Table 1. /dbsafer/api/v1/object/datamasks/{index}
Parameter Description

index

데이터마스킹 Index

3.4.3. Request fields

Name Type Description Required

name

String

데이터마스킹 명

kind

String

데이터마스킹 종류 (REGEX/COLUMN)

value

String

데이터마스킹 값

startDate

String

유효기간 시작일

endDate

String

유효기간 종료일

comment

String

설명

owner

String

소유자

3.4.4. HTTP response

HTTP/1.1 200 OK

3.4.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/datamasks/1' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "name" : "datamask001",
  "kind" : "REGEX",
  "value" : "/^[0-9]*$/",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for datamask001"
}'

3.5. 데이터마스킹 삭제

등록된 데이터마스킹을 삭제하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

3.5.1. HTTP request

DELETE /dbsafer/api/v1/object/datamasks/1 HTTP/1.1
Host: localhost:3182

3.5.2. Path parameters

Table 1. /dbsafer/api/v1/object/datamasks/{index}
Parameter Description

index

데이터마스킹 Index

3.5.3. HTTP response

HTTP/1.1 204 No Content

3.5.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/datamasks/1' -i -X DELETE

4. IP 주소 관리

4.1. IP 주소 목록 조회

등록된 IP 주소 목록을 조회하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

4.1.1. HTTP request

GET /dbsafer/api/v1/object/ip-addresses HTTP/1.1
Accept: application/json
Host: localhost:3182

4.1.2. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 231

{
  "results" : [ {
    "index" : 1,
    "ipFrom" : "1.1.1.1",
    "ipTo" : "2.2.2.2",
    "mac" : "",
    "startDate" : "2022-01-01T00:00:00",
    "endDate" : "2022-12-31T23:59:59",
    "comment" : "comment for ip-address"
  } ]
}

4.1.3. Response fields

Name Type Description Required

results.[].index

Number

IP 주소 Index

results.[].ipFrom

String

IP 주소 시작

results.[].ipTo

String

IP 주소 종료

results.[].mac

String

MAC 주소

results.[].startDate

String

유효기간 시작일

results.[].endDate

String

유효기간 종료일

results.[].comment

String

설명

4.1.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/ip-addresses' -i -X GET \
    -H 'Accept: application/json'

4.2. IP 주소 조회

등록된 IP 주소를 조회하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

4.2.1. HTTP request

GET /dbsafer/api/v1/object/ip-addresses/1 HTTP/1.1
Accept: application/json
Host: localhost:3182

4.2.2. Path parameters

Table 1. /dbsafer/api/v1/object/ip-addresses/{index}
Parameter Description

index

IP 주소 Index

4.2.3. HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 193

{
  "index" : 1,
  "ipFrom" : "1.1.1.1",
  "ipTo" : "2.2.2.2",
  "mac" : "",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for ip-address"
}

4.2.4. Response fields

Name Type Description Required

index

Number

IP 주소 Index

ipFrom

String

IP 주소 시작

ipTo

String

IP 주소 종료

mac

String

MAC 주소

startDate

String

유효기간 시작일

endDate

String

유효기간 종료일

comment

String

설명

4.2.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/ip-addresses/1' -i -X GET \
    -H 'Accept: application/json'

4.3. IP 주소 추가

신규 IP 주소를 추가하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

4.3.1. HTTP request

POST /dbsafer/api/v1/object/ip-addresses HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 178
Host: localhost:3182

{
  "ipFrom" : "1.1.1.1",
  "ipTo" : "2.2.2.2",
  "mac" : "",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for ip-address"
}

4.3.2. Request fields

Name Type Description Required

ipFrom

String

IP 주소 시작

ipTo

String

IP 주소 종료

mac

String

MAC 주소

startDate

String

유효기간 시작일

endDate

String

유효기간 종료일

comment

String

설명

owner

String

소유자

4.3.3. HTTP response

HTTP/1.1 201 Created

4.3.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/ip-addresses' -i -X POST \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "ipFrom" : "1.1.1.1",
  "ipTo" : "2.2.2.2",
  "mac" : "",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for ip-address"
}'

4.4. IP 주소 수정

등록된 IP 주소 정보를 수정하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

4.4.1. HTTP request

PUT /dbsafer/api/v1/object/ip-addresses/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Content-Length: 178
Host: localhost:3182

{
  "ipFrom" : "1.1.1.1",
  "ipTo" : "2.2.2.2",
  "mac" : "",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for ip-address"
}

4.4.2. Path parameters

Table 1. /dbsafer/api/v1/object/ip-addresses/{index}
Parameter Description

index

IP 주소 Index

4.4.3. Request fields

Name Type Description Required

ipFrom

String

IP 주소 시작

ipTo

String

IP 주소 종료

mac

String

MAC 주소

startDate

String

유효기간 시작일

endDate

String

유효기간 종료일

comment

String

설명

owner

String

소유자

4.4.4. HTTP response

HTTP/1.1 200 OK

4.4.5. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/ip-addresses/1' -i -X PUT \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json' \
    -d '{
  "ipFrom" : "1.1.1.1",
  "ipTo" : "2.2.2.2",
  "mac" : "",
  "startDate" : "2022-01-01T00:00:00",
  "endDate" : "2022-12-31T23:59:59",
  "comment" : "comment for ip-address"
}'

4.5. IP 주소 삭제

등록된 IP 주소를 삭제하는 API를 소개합니다. 상세 내용은 아래를 참고합니다.

4.5.1. HTTP request

DELETE /dbsafer/api/v1/object/ip-addresses/1 HTTP/1.1
Host: localhost:3182

4.5.2. Path parameters

Table 1. /dbsafer/api/v1/object/ip-addresses/{index}
Parameter Description

index

IP 주소 Index

4.5.3. HTTP response

HTTP/1.1 204 No Content

4.5.4. Curl request

$ curl 'https://localhost:3182/dbsafer/api/v1/object/ip-addresses/1' -i -X DELETE

(주)피앤피시큐어

대표이사   박천오

대표번호   1670-9295          영업문의   sales@pnpsecure.com

사업자등록번호   107-86-44093

서울특별시 강서구 마곡서로 182(마곡동, 피앤피스테이션)


Copyright ⓒ 2023 pnpsecure All rights reserved. |개인정보 처리방침