diff --git a/res/include/md/api.md b/res/include/md/api.md index 98e177d..eda82ce 100644 --- a/res/include/md/api.md +++ b/res/include/md/api.md @@ -4,12 +4,8 @@ Methods for using pixeldrain programmatically. ## Authentication -The methods for uploading and retrieving files don't require an API key. The -methods for creating and retrieving lists also don't require an API key. All -methods which delete or modify a resource **do** require an API key. - -API keys can be obtained from your user account's [API keys -page](/user/api_keys). +All methods which create, modify or delete a resource require an API key. API +keys can be obtained from your user account's [API keys page](/user/api_keys). To use the API key you need to enter it in the password field of [HTTP Basic Access @@ -43,13 +39,9 @@ URL. ## curl example -Here's how to anonymously upload a file using curl: - -`curl -T "file_name.txt" https://pixeldrain.com/api/file/` - -You can also upload a file to your pixeldrain account using curl. Get an API key -from the [API keys page](/user/api_keys) and enter it in the command. Replace -the example API key here with your own: +To upload files to pixeldrain you will need an API key. Get an API key from the +[API keys page](/user/api_keys) and enter it in the command. Replace the example +API key here with your own: `curl -T "file_name.txt" -u :5f45f184-64bb-4eaa-be19-4a5f0459db49 https://pixeldrain.com/api/file/` diff --git a/res/include/md/api_file.md b/res/include/md/api_file.md index 82597d6..9ec80e4 100644 --- a/res/include/md/api_file.md +++ b/res/include/md/api_file.md @@ -12,11 +12,10 @@ performance issues in certain environments. ### Parameters -Param | Type | Required | Maximum Size | Default | Description -----------|----------------|----------|------------------------------|---------------------|----------------------------------- -name | string | false | 255 characters | multipart file name | Name of the file to upload -anonymous | boolean | false | N/A | false | File is not linked to user if true -file | multipart file | true | Depends on user subscription | none | File to upload +Param | Type | Required | Maximum Size | Default | Description +------|----------------|----------|------------------------------|---------------------|---------------------------- +name | string | false | 255 characters | multipart file name | Name of the file to upload +file | multipart file | true | Depends on user subscription | none | File to upload ### Returns @@ -85,11 +84,10 @@ Upload a file. ### Parameters -Param | Type | Required | Location | Maximum Size | Default | Description -----------|---------|----------|---------------|------------------------------|---------|----------------------------------- -name | string | true | URL | 255 characters | none | Name of the file to upload -anonymous | boolean | false | URL parameter | N/A | false | File is not linked to user if true -file | file | true | request body | Depends on user subscription | none | File to upload +Param | Type | Required | Location | Maximum Size | Default | Description +------|--------|----------|--------------|------------------------------|---------|---------------------------- +name | string | true | URL | 255 characters | none | Name of the file to upload +file | file | true | request body | Depends on user subscription | none | File to upload ### Returns