Documentation Powered by ReDoc

GROWI REST API v3 (7.0.21-RC.0)

Download OpenAPI specification:Download

Authentication

api_key

Security scheme type: API Key
Query parameter name: access_token

adminHome

AppSettings

/app-settings

get app setting params

Authorizations:
api_key

Responses

200

Resources are available

get /app-settings
https://demo.growi.org/_api/v3/app-settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "appSettingsParams": { }
}

/app-settings/app-setting

Update app setting

Authorizations:
api_key
Request Body schema: application/json
title
string

site name show on page header and tilte of HTML

confidential
string

confidential show on page header

globalLang
string

language set when create user

isEmailPublishedForNewUser
boolean

default email show/hide setting when create user

fileUpload
boolean

enable upload file except image file

Responses

200

Succeeded to update app setting

put /app-settings/app-setting
https://demo.growi.org/_api/v3/app-settings/app-setting

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "title": "string",
  • "confidential": "string",
  • "globalLang": "string",
  • "isEmailPublishedForNewUser": true,
  • "fileUpload": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "title": "string",
  • "confidential": "string",
  • "globalLang": "string",
  • "isEmailPublishedForNewUser": true,
  • "fileUpload": true
}

/app-settings/site-url-setting

Update site url setting

Authorizations:
api_key
Request Body schema: application/json
siteUrl
envSiteUrl
string

environment variable 'APP_SITE_URL'

Responses

200

Succeeded to update site url setting

put /app-settings/site-url-setting
https://demo.growi.org/_api/v3/app-settings/site-url-setting

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "siteUrl": "string",
  • "envSiteUrl": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "siteUrl": "string",
  • "envSiteUrl": "string"
}

/app-settings/smtp-setting

Update smtp setting

Authorizations:
api_key
Request Body schema: application/json
smtpHost
string

host name of client's smtp server

smtpPort
string

port of client's smtp server

smtpUser
string

user name of client's smtp server

smtpPassword
string

password of client's smtp server

Responses

200

Succeeded to update smtp setting

put /app-settings/smtp-setting
https://demo.growi.org/_api/v3/app-settings/smtp-setting

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "smtpHost": "string",
  • "smtpPort": "string",
  • "smtpUser": "string",
  • "smtpPassword": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "smtpHost": "string",
  • "smtpPort": "string",
  • "smtpUser": "string",
  • "smtpPassword": "string"
}

/app-settings/smtp-setting

Send test mail for smtp

Authorizations:
api_key

Responses

200

Succeeded to send test mail for smtp

post /app-settings/smtp-test
https://demo.growi.org/_api/v3/app-settings/smtp-test

/app-settings/ses-setting

Update ses setting

Authorizations:
api_key
Request Body schema: application/json
accessKeyId
string

accesskey id for authentification of AWS

secretAccessKey
string

secret key for authentification of AWS

Responses

200

Succeeded to update ses setting

put /app-settings/ses-setting
https://demo.growi.org/_api/v3/app-settings/ses-setting

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "accessKeyId": "string",
  • "secretAccessKey": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "accessKeyId": "string",
  • "secretAccessKey": "string"
}

/app-settings/file-upload-setting

Update fileUploadSetting

Authorizations:
api_key
Request Body schema: application/json
fileUploadType
string

fileUploadType

s3Region
string

region of AWS S3

s3CustomEndpoint
string

custom endpoint of AWS S3

s3Bucket
string

AWS S3 bucket name

s3AccessKeyId
string

accesskey id for authentification of AWS

s3SecretAccessKey
string

secret key for authentification of AWS

s3ReferenceFileWithRelayMode
boolean

is enable internal stream system for s3 file request

gcsApiKeyJsonPath
string

apiKeyJsonPath of gcp

gcsBucket
string

bucket name of gcs

gcsUploadNamespace
string

name space of gcs

gcsReferenceFileWithRelayMode
boolean

is enable internal stream system for gcs file request

envGcsApiKeyJsonPath
string

Path of the JSON file that contains service account key to authenticate to GCP API

envGcsBucket
string

Name of the GCS bucket

envGcsUploadNamespace
string

Directory name to create in the bucket

Responses

200

Succeeded to update fileUploadSetting

put /app-settings/file-upload-settings
https://demo.growi.org/_api/v3/app-settings/file-upload-settings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fileUploadType": "string",
  • "s3Region": "string",
  • "s3CustomEndpoint": "string",
  • "s3Bucket": "string",
  • "s3AccessKeyId": "string",
  • "s3SecretAccessKey": "string",
  • "s3ReferenceFileWithRelayMode": true,
  • "gcsApiKeyJsonPath": "string",
  • "gcsBucket": "string",
  • "gcsUploadNamespace": "string",
  • "gcsReferenceFileWithRelayMode": true,
  • "envGcsApiKeyJsonPath": "string",
  • "envGcsBucket": "string",
  • "envGcsUploadNamespace": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fileUploadType": "string",
  • "s3Region": "string",
  • "s3CustomEndpoint": "string",
  • "s3Bucket": "string",
  • "s3AccessKeyId": "string",
  • "s3SecretAccessKey": "string",
  • "s3ReferenceFileWithRelayMode": true,
  • "gcsApiKeyJsonPath": "string",
  • "gcsBucket": "string",
  • "gcsUploadNamespace": "string",
  • "gcsReferenceFileWithRelayMode": true,
  • "envGcsApiKeyJsonPath": "string",
  • "envGcsBucket": "string",
  • "envGcsUploadNamespace": "string"
}

Attachment

Get attachment list

Get attachment list

Authorizations:
api_key
query Parameters
page_id
required
string

page id

Responses

200

Return attachment list

get /attachment/list
https://demo.growi.org/_api/v3/attachment/list

/attachment/limit

Get available capacity of uploaded file with GridFS

Authorizations:
api_key
query Parameters
fileSize
required
number
Example: fileSize=23175

file size

Responses

200

Succeeded to get available capacity of uploaded file with GridFS.

403

Forbidden

500

Internal Server Error

get /attachment/limit
https://demo.growi.org/_api/v3/attachment/limit

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "isUploadable": true
}

/attachment

Add attachment to the page

Authorizations:
api_key
Request Body schema:
multipart/form-data
page_id
string Nullable
path
string Nullable
file
string <binary>

attachment data

Responses

200

Succeeded to add attachment.

403

Forbidden

500

Internal Server Error

post /attachment
https://demo.growi.org/_api/v3/attachment

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "page":
    {